Aller au contenu

Introduction ​

Bienvenue dans la documentation de l’API de Pocket Alert. Ce document présente en détail les fonctionnalités de notre API et vous guide pour une interaction fluide avec notre système. Vous trouverez ci-dessous les informations essentielles sur l’authentification, une étape indispensable avant toute requête API.

Authentification ​

Notre API prend en charge deux mécanismes d’authentification, adaptés à différents cas d’usage et préférences :

1. Authentification par jeton JWT ​

Vous pouvez obtenir un jeton JWT (JSON Web Token) via la méthode d’authentification de notre API.

Pour commencer avec l’authentification par jeton JWT, envoyez une requête au point de terminaison d’autorisation, comme illustré dans les sections suivantes de cette documentation.

2. Jetons pré-créés ​

Vous pouvez également utiliser des jetons pré-créés pour vous authentifier. Ces jetons se créent et se gèrent dans la section Clés API de votre compte. Cette méthode vous permet d’accéder simplement à notre API, sans étape d’autorisation supplémentaire.

Passez aux sections suivantes pour approfondir les spécificités de notre API, notamment les descriptions des points de terminaison, des exemples de requêtes et de réponses, les codes de statut, les messages d’erreur, et bien plus encore. Votre parcours vers une intégration fluide avec notre service commence ici !

Remarque importante ​

Lorsque vous effectuez des requêtes vers notre API, veillez à inclure les en-têtes nécessaires dans votre requête.

Vous pouvez utiliser l’un ou l’autre des types d’autorisation, mais nous vous recommandons d’utiliser des jetons, afin de pouvoir séparer l’accès de différents services et applications à vos données.

Accéder au guide de démarrage rapide ​

Documentation de Pocket Alert