FAQ
- Notre site s'adresse :
- Aux consommateurs d’APIs du Groupe La Poste. Il s’agit bien souvent de responsables de site e-commerce, de développeurs, de chefs de projets, de responsables informatique… qui souhaitent intégrer des services de La Poste dans leur système d’information, leur site web ou leur application.
- Aux fournisseurs d’APIs. A ce jour, seules les entités du Groupe La Poste sont autorisées à exposer leurs APIs publiques ou privées.
Voir la procédure de raccordement d’une API.
- Pour s’inscrire sur developer.laposte.fr, seuls une adresse email valide, un pseudo et un mot de passe sont nécessaires. Ils seront suffisants pour commencer à consommer nos APIs.
- Par défaut, la consommation des APIs exposées sur ce site est gratuite. Dans le cas contraire, les conditions sont indiquées sur la fiche catalogue de l’API. A noter que la consommation de certaines APIs peut être limitée en volume afin de protéger L’API d’attaques massives.
Dans ce cas, Okapi retournera un code HTTP 429 avec une réponse suivante, par exemple:{"code":"TOO_MANY_REQUESTS", "message":"max quota reached 100 calls per minute"}.
- Les questions commerciales et marketing concernant les APIs sont à poser directement au service clients
Pour les questions techniques sur les APIs ou sur l’utilisation du site developer.laposte.fr, nous vous conseillons de consulter :- Les FAQ pour les questions générales.
- Les Premiers Pas pour obtenir les informations de base pour consommer nos APIs ou pour proposer une API (cette dernière possibilité étant réservée aux entités du Groupe La Poste).
- La documentation de l’API sélectionnée pour prendre connaissance du paramétrage propre à cette API (choisir l’API dans le catalogue).
- L’équipe de support de l’API. Pour certaines APIs, l’adresse email de leur support technique est indiqué dans la documentation.
- Notre forum Gitter pour vérifier si votre question n’a pas déjà été traitée, échanger avec le support technique ou les autres utilisateurs.
- Enfin, et en dernier recours, l’équipe en charge du raccordement d’API est joignable par email.
- Un compte est automatiquement suspendu après 5 tentatives infructueuses de saisie de mot de passe. Deux solutions pour débloquer un compte :
- Patienter 24h00, le temps que le compte soit automatiquement débloqué.
- S'adresser à nos équipes de support depuis l'adresse email utilisée sur developer.laposte.fr.
- Pour pouvoir utiliser les APIs de La Poste, votre application doit au préalable s'authentifier. L'authentification utilisée dans tous les appels APIs est basée sur une clé d'application que vous pouvez à tout moment révoquer ou renouveler.
Pour obtenir vos clés :- identifiez-vous avec votre compte ou inscrivez-vous
- puis accédez à vos applications
curl https://api.laposte.fr/suivi/v1/1231231231231 -H "X-Okapi-Key: xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Si la clé d’application est erronée, un code d’erreur http 401 {"code”:“AUTHORIZATION”, “message”:“Autorisation requise”} est retourné.
- Chaque ressource API est localisée par son URI.
Format des URI :
Les ressources APIs sont exposées avec un chemin d'URI qui respecte le format suivant :
https://api.laposte.fr/[nomapi]/[version]/[cheminRessource]
Le chemin d'URI est donc composé des éléments suivants :- nom du fournisseur d'API (exemple : superapi)
- version de l'API (exemple : v1)
- chemin de la ressource (exemple : chemin/ressource)
https://api.laposte.fr/superapi/v1/chemin/ressource
- Lorsque vous obtenez une erreur lors de l’appel à une API, il est important de vérifier les entêtes du retour. En effet, l’API peut retourner un code HTTP d’erreur (par exemple 400 ou 500) qui peut être lié à l’API distante ou bien à Okapi.
Dans ce cas, les entêtes de la réponse contient une clé x-okapi-successful avec la valeur à true si l’erreur vient de l’API distante.
Sinon si l’erreur est lié a Okapi et non a l’API distante le retour sera égal à false, il faudra alors contacté l’équipe de support pour obtenir de l’aide.