Developer (API)

Direct link to the API documentation: docs.paperlesspaper.de

In addition to the app, paperlesspaper also offers a API with which developers can integrate custom applications or existing systems.

The API is currently in beta. Some things may change in the future.

All information about the API and other options can be found on GitHub.

Getting started

To use the API, you must:

• Use a valid API key to send requests to the API endpoints.
  Your API key can be found in the paperlesspaper app.
• Only HTTPS connections are allowed. HTTP requests will be redirected to HTTPS with an HTTP 301 redirect.
• The API returns responses in JSON format. Errors appear in the JSON body under the key error.

How do I create tokens?

You can generate API keys in your User settings.

Where can I find the API documentation?

You can find the API documentation here.

API token authentication

You can generate a custom API token in the paperlesspaper app.
To authenticate, add the API token to the x-api-key header:

x-api-key: <your-token>

• The API token must be a 64-character hexadecimal value.
• If the token is valid, the request will be authenticated on behalf of the associated user.

Authentication error messages

• 401 Unauthorized: Token is missing, invalid, or expired.
• 403 Forbidden: Authenticated but does not have permission for the endpoint.

Rate and usage limits

Access restrictions apply per API key and time period.
The limit is 300 requests per minute.
If the limit is exceeded, you will receive the HTTP status 429 Too Many Requests.

HTTP 503 response

An HTTP 503 error indicates an unexpected spike in API traffic.
The server is typically available again within five minutes.
For persistent issues or other HTTP 5XX errors, please contact the Support.

Deep linking into the app

The app supports deep linking, allowing users from other apps or websites to navigate directly to specific functions or pages in the app.

Example

https://web.paperlesspaper.de/account

Links directly to the account settings when the app is installed

https://web.paperlesspaper.de/account#no_universal_links

With the hash #no_universal_link the deep linking can be disabled.