Back to overview

Developer (API)

Integrate paperlesspaper directly into your applications.

In addition to the app, paperlesspaper also offers an API that allows developers to integrate custom applications or existing systems.

The API is currently in beta. Therefore, some things may change in the future.

Getting Started

To use the API, you must:

  • Use a valid API key to send requests to the API endpoints.
    You can obtain your API key in the paperlesspaper application.
  • Only HTTPS connections are allowed. Requests over HTTP are redirected to HTTPS via HTTP 301 redirect.
  • The API returns responses in JSON format. Errors appear in the JSON body under the key error.
ChatGPT Image 17

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 documentation here.

Authentication

The API uses two authentication methods:
Custom API tokens and Auth0 JWT tokens.

API Token Authentication

You can generate a custom API token in the paperlesspaper app or through your administrator.
To authenticate, add the API token to the Authorization header as a Bearer token:

x-api-key: <Your-Token>

  • The API token must be a 64-digit 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 no permission for the endpoint.

Rate and Usage Limits

Access restrictions apply per API key and time unit.
The limit is 300 requests per minute.
Additionally, further usage limits may apply depending on the plan.
If exceeded, you will receive the HTTP status 429 Too Many Requests.

HTTP 503 Response

An HTTP 503 error indicates an unexpected peak load in API access.
The server is usually available again within five minutes.
If the disruption persists or other HTTP 5XX errors occur, please contact support.

Deep Linking into the App

The app supports deep linking, allowing users to navigate directly to specific features or pages within the app from other applications or websites.

Example

https://web.wirewire.de/account

Links directly to the account settings if the app is installed

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

With the hash #no_universal_link deep linking can be disabled.

Back to overview