Aller au contenu principal

Guide de connexion et d'utilisation de l'API Akisplataforma

Ce guide explique étape par étape comment se connecter à l'API Akisplataforma , les identifiants nécessaires et comment effectuer correctement les requêtes. Le flux de connexion est basé sur la norme OAuth 2.0 , ce qui signifie que vous devez d'abord obtenir un jeton d'accès , puis l'utiliser pour accéder aux données.

De quoi ai-je besoin pour me connecter à l'API ?

Pour utiliser l'API, vous avez besoin d'informations d'identification personnelles.

  • Ces identifiants sont disponibles dans votre espace utilisateur sur le site.
  • Dans la section « API », vous trouverez les informations dont vous avez besoin pour utiliser :
    • nom d'utilisateur : ID utilisateur pour l'API (vous le trouverez dans l'espace API de votre compte utilisateur).
    • mot de passe : Il s'agit du même mot de passe que vous utilisez pour vous connecter au site Web.
    • client_id : identifiant de connexion API (vous le trouverez dans l'espace API de votre compte utilisateur).
image de la section API dans le compte utilisateur

Comment puis-je me connecter ?

Maintenant que vous disposez de vos identifiants, vous pouvez vous connecter. La connexion est conforme à la norme OAuth 2.0, qui se caractérise par un processus en deux étapes :

  • Étape 1 : Demander un jeton d’accès (authentification).
  • Étape 2 : consommez l’API à l’aide de ce jeton (requête de données).

Vous pouvez le faire par programmation (JavaScript, Python, PHP, etc.) ou à l'aide d'un outil comme Postman. (Nous avons joint des exemples d'images à une requête utilisant Postman.)

Étape 1 : Demander un jeton d’accès

Vous devez faire une requête POST à l'URL : https://akisplataforma.es/oauth/token avec le contenu suivant dans le corps de la requête (format application/json ) :
{
"grant_type": "password",
"client_id": "TU_CLIENT_ID_API",
"username": "TU_EMAIL_API",
"password": "TU_CONTRASEÑA"
}

L'image suivante montre comment faire la requête et la réponse attendue, la partie importante de la réponse est le access_token :

image de demande de jeton

Étape 2 : Exécuter la requête de données

Maintenant que vous avez votre jeton, faites une deuxième demande pour consommer l'un des points de terminaison API publiés sur https://akisplataforma.es/api-documentacion , par exemple, pour obtenir les données liées aux actualités, nous devons faire une requête en utilisant la méthode get au point de terminaison https://akisplataforma.es/api/news en utilisant le jeton obtenu précédemment.

image de la requête vers le point de terminaison des actualités