Développeur (API)

Accès direct à la documentation de l'API : docs.paperlesspaper.de

En plus de l'application, paperlesspaper propose également une API avec laquelle les développeurs peuvent intégrer des applications personnalisées ou des systèmes existants.

L'API est actuellement en version bêta. Il est donc possible que certaines choses changent à l'avenir.

Toutes les informations concernant l'API et d'autres possibilités se trouvent sur GitHub.

Premiers pas

Pour utiliser l'API, tu dois :

• Utiliser une clé API valide pour envoyer des requêtes aux points de terminaison de l'API.
  Ta clé API se trouve dans l'application paperlesspaper.
• Seules les connexions HTTPS sont autorisées. Les requêtes HTTP sont redirigées vers HTTPS via une redirection 301.
• L'API renvoie des réponses au format JSON. Les erreurs apparaissent dans le corps JSON sous la clé error.

Comment créer des jetons ?

Tu peux générer des clés API dans tes Paramètres utilisateur.

Où puis-je trouver la documentation de l'API ?

Tu trouveras la documentation de l'API ici.

Authentification par token API

Vous pouvez générer un token API personnalisé dans l'application paperlesspaper.
Pour l'authentification, ajoutez le token API à l'en-tête x-api-key :

x-api-key: <votre-token>

• Le token API doit être une valeur hexadécimale de 64 caractères.
• Si le token est valide, la requête sera authentifiée au nom de l'utilisateur associé.

Messages d'erreur d'authentification

• 401 Non autorisé: token manquant, invalide ou expiré.
• 403 Interdit: authentifié, mais sans autorisation pour ce point de terminaison.

Limites de taux et d'utilisation

Les restrictions d'accès s'appliquent par clé API et unité de temps.
La limite est de 300 requêtes par minute.
En cas de dépassement, vous recevrez le statut HTTP 429 Trop de requêtes.

Réponse HTTP 503

Une erreur HTTP 503 indique un pic de charge inattendu dans l'accès à l'API.
Le serveur est généralement de nouveau disponible dans les cinq minutes.
En cas de panne persistante ou d'autres erreurs HTTP 5XX, veuillez contacter le Support.

Deep linking dans l'application

L'application prend en charge le deep linking, permettant aux utilisateurs, depuis d'autres applications ou sites web, d'accéder directement à des fonctions ou pages spécifiques de l'application.

Exemple

https://web.paperlesspaper.de/account

Redirige directement vers les paramètres du compte si l'application est installée.

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

Avec le hash #no_universal_link le deep linking peut être désactivé.