Contexte
Afin de sécuriser l’accès aux données retournées par l’API, vous devez fournir une clé d’authentification lors de chaque appel. Pour simplifier l’utilisation, le système d’authentification est basé sur la méthode Basic Access, mais comme les informations d’identification sont envoyées non chiffrées, l’authentification est obligatoirement sécurisée via HTTPS.
Les clés sont disponibles uniquement depuis l’interface du BackOffice.
À noter : ces clés ne sont pas directement liées à votre compte utilisateur, mais représente l’équivalent d’un compte de service.
Attention ! Pour des questions de sécurité, les requêtes doivent être réalisées de Serveur à Serveur.
Procédure
1) Accédez à la plage dédiée aux APIs
- Cliquez sur « Intégration » depuis le menu de gauche.
- Cliquez ensuite sur le bouton « API » depuis le sous menu.
2) Récupérer les Clés
Une fois sur la page dédiée, i vous suffit de récupérer les clés :
La « clé Agent » correspond au “Username” de la méthode Basic Access.
La « clé API » correspond à au “Password” de la méthode Basic Access.
À noter : le champ “Endpoint API” correspond uniquement à l’API live.
3) Construisez correctement les Headers
Pour construire la clé d’authentification.
- Concaténez la clé agent avec la clé api séparé par le caractère “:”
ex : si la clé API =c7fa57b8-4861-4857et la clé agent =f6797af1-791b-40b1alors le résultat =c7fa57b8-4861-4857:f6797af1-791b-40b1 - Une fois encodez la chaîne crée en Base-64
YzdmYTU3YjgtNDg2MS00ODU3OmY2Nzk3YWYxLTc5MWItNDBiMQ== - Ajoutez la chaine encodée comme clé d’authentification dans l’entête (Header) de la requête.
Authorization: Basic YzdmYTU3YjgtNDg2MS00ODU3OmY2Nzk3YWYxLTc5MWItNDBiMQ==
Exemple de requête avec Curl:
AUTH=$(echo -ne "$AGENT_KEY:$API_KEY" | base64 --wrap 0)
curl \
--header "Content-Type: application/json" \
--header "Authorization: Basic $AUTH" \
--request POST \
--data '{"Email":"john@doe.com", "Name":"Mr Doe"}' \
https://xxxx.proabono.com/v1/Customer