Etape 3 - Requêter une API

L'URL permettant de requêter une API est constituée des éléments suivants :

  1. le point d'accès  https://api.emploi-store.fr/partenaire
  2. l'identifiant de l'API (code et version de l'API)
  3. le nom de la ressource
  4. les paramètres spécifiques à l'API manipulée

Ainsi, une requête se présente sous la forme :

https://api.emploi-store.fr/partenaire/[Code de l'API]/[Version de l'API]/[Nom de la ressource][Paramètres spécifiques à l'API]

 

L'en-tête HTTP suivant doit être valorisé systématiquement :

En-tête(s) Valeur
Authorization Bearer Valeur de l'access token

 

Exemple d'appel :

GET /partenaire/peconnect-individu/v1/userinfo

Authorization: Bearer [Access token]

 

Exemple de retour :

HTTP 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
  "sub": "[Identifiant technique]",
  "gender": "[Sexe]",
  "family_name": "[Nom]",
  "given_name": "[Prénom]",
  "email": "[Email]"
}

 

Cas d'erreurs possibles

Access token erroné ou absent :

HTTP 401 Unauthorized
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache

{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}