Cost+Docs

Authentification

Découvrez comment vous authentifier auprès de l'API Cost+

Toute communication avec l'API Cost+ nécessite TLS 1.2 ou supérieur et l'authentification HTTP Basic.

Fonctionnement de l'authentification Basic

Authentifiez-vous en utilisant votre clé API comme nom d'utilisateur avec un mot de passe vide. Encodez en Base64 la chaîne \{api_key\}: (notez les deux-points à la fin — le mot de passe est vide).

L'en-tête Authorization résultant ressemble à ceci :

Authorization: Basic aHVudGVyMjo=

N'exposez jamais votre clé API dans du code côté client ou dans des dépôts publics. Conservez-la exclusivement côté serveur.

Utilisation avec cURL

Méthode native (recommandée)

cURL prend en charge nativement l'authentification Basic avec le flag -u. Passez votre clé API suivie de deux-points :

cURL avec le flag -u
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/

Encodage Base64 manuel

Si vous préférez construire l'en-tête vous-même, encodez d'abord la clé :

Encoder la clé API
echo -n "YOUR_API_KEY:" | base64

Puis passez la valeur encodée dans l'en-tête Authorization :

cURL avec en-tête Authorization manuel
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/

Les deux-points après la clé API sont obligatoires — ils séparent le nom d'utilisateur du mot de passe (vide) dans le schéma Basic Auth.

Codes de statut HTTP

L'API utilise les codes de statut HTTP standard pour indiquer le résultat d'une requête.

Code de statutSignificationDescription
200OKLa requête a réussi.
201CrééLa ressource a été créée avec succès.
400Requête invalideLa requête est malformée ou des champs obligatoires sont manquants.
401Non autoriséL'authentification a échoué — vérifiez votre clé API.
403InterditVous n'avez pas la permission d'accéder à cette ressource.
404Non trouvéLa ressource demandée n'existe pas.
500Erreur interne du serveurUn problème est survenu de notre côté.
502Mauvaise passerelleErreur du service en amont.
503Service indisponibleL'API est temporairement indisponible.
504Délai de passerelle dépasséLe service en amont n'a pas répondu à temps.

On this page