Getting Started with Papershift API

Use the following short description to activate your Papershift API functions

1. Activate the Papershift API Addon

Log in into your Papershift account. Then press the wrench button on the left side of your Account. Now you can see some new buttons. Press the places- button (Standorte). Press the crossed screwdriver/ wrench button and switch to the API section. Now activate your API. Presently a bar should appear on the top with the content "API activated".

2. Get your Papershift API Key

Log in into your Papershift account. Then press the wrench button on the left side of your Account. Now you can see some new buttons. Press the places- button (Standorte). Press the crossed screwdriver/ wrench button and switch to the API section. Now press the plus button right of actions to create a new API Key.

3. Some Facts to know about the Papershift API

API Base URL
The production base API URL is https://app.papershift.com/public_api/v1/

Authentication
All requests MUST contain an api_token which identifies the client to the API. This is needed in order to protect the API from misuse and offer special services to specific clients if needed. To create your own API Keys, please log in on papershift.com/signin and go to the API-Section on the Account’s overview.

Interface Language
In order to be able to give some specific answers in a language the requesting user understands and in order to provide language consistency, all requests to this API MUST contain an ISO 639-1 code of two characters length with the user's interface language via the key interface_language. Please make sure the chosen languages is the language the client presents its content to the user, which is not necessarily the same as the user's most preferred language or the user's device's language.

HTTP
All requests to this API SHOULD be made with the HTTP Header fields Content-Type and Accept set to application/json. Beware though that the HTTP/1.1 specification doesn’t allow sending meaningful data via the Body for GET requests.

Request Structure Recommendation
So sum up all the above sections, this is what a basic request SHOULD always contain:

-api_token via Request-Body or URL parameters
-all other parameters via HTTP Body parameters (if any available)
External ID

This API uses external IDs to identify records in the database. When enabling API-Mode Forms for users, absences and absence types will contain an input field for the external ID. These have to be unique for each Model on Account-Scope and can only be set or modified by users with the role Account Admin.

Something missing?

Please share your feedback with us here:

https://developers.papershift.com/discuss or via email to [email protected]