Développeur (API)

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

Premiers pas

Pour utiliser l'API, vous devez :

• Utiliser une clé API valide pour envoyer des requêtes aux points de terminaison de l'API.
  Vous obtenez votre clé API dans l'application paperlesspaper.
• Seules les connexions HTTPS sont autorisées. Les requêtes via HTTP sont redirigées vers HTTPS par un redirection HTTP 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?

Vous pouvez générer des clés API dans vos paramètres utilisateur.

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

Vous trouverez la documentation ici.

Authentification

L'API utilise deux méthodes d'authentification :
Propres tokens API et Tokens JWT Auth0.

Authentification par jeton API

Vous pouvez générer un jeton API personnalisé dans l'application paperlesspaper ou via votre administrateur.
Pour l'authentification, ajoutez le jeton API à l'en-tête Authorization en tant que jeton Bearer :

Authorization: Bearer <Votre-Token>

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

Messages d'erreur d'authentification

• 401 Non autorisé: Jeton manquant, invalide ou expiré.
• 403 Interdit: Authentifié, mais pas d'autorisation pour le point d'accès.

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 outre, des limites d'utilisation supplémentaires peuvent s'appliquer selon le plan tarifaire.
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 disponible à nouveau dans les cinq minutes.
En cas de perturbation persistante ou d'autres erreurs HTTP 5XX, veuillez contacter le support.

Liens profonds dans l'application

L'application prend en charge les liens profonds, permettant aux utilisateurs de naviguer directement vers des fonctionnalités ou des pages spécifiques dans l'application depuis d'autres applications ou sites web.

Exemple

https://web.wirewire.de/account

Lien direct vers les paramètres du compte si l'application est installée

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

Avec le hash #no_universal_link le lien profond peut être désactivé.