En-têtes HTTP
Cette section décrit les en-têtes HTTP que l'API acceptera dans toute requête.
Content-Type
Toutes les demandes doivent contenir un en-tête HTTP de type contenu.
Types de contenu acceptés
| Format de base | Types de contenu | Types de contenu |
|---|---|---|
| JSON | application/json | text/json n'est actuellement pas un type de contenu accepté |
| Données du formulaire | multipart/form-data | Utilisé uniquement lors du téléchargement de variations |
Erreurs de type de contenu
| Code de réponse | Notes |
|---|---|
| 400 | Le type de contenu a été compris mais n'a pas pu être décodé. De plus amples informations apparaîtront dans le corps de la réponse |
| 415 | Le type de contenu est manquant ou n'est pas pris en charge |
Note : Dans les cas où l'en-tête content-type pose problème, le content-type de la réponse sera le format par défaut de l'API, actuellement application/json.
Note : L'API n'adhère pas actuellement à l'en-tête HTTP Accept-type, toutes les réponses sont envoyées dans le même type de contenu que la demande reçue, à condition que le type de contenu de la demande soit valide.
Autorisation
Cet en-tête est facultatif et sert à fournir des détails d'authentification à l'API pour l'utilisateur actuel, ce qui lui permettra d'accéder aux ressources restreintes de l'API. Les jetons peuvent être obtenus via l'API de connexion. Un exemple d'en-tête est le suivant :
Authorization: Bearer 45267dbe480c8c7d799c62ccad92cb44f67ab086
L'en-tête Authorization accepte une chaîne composée de deux parties, séparées par un espace. La première partie est le type de jeton, la seconde est le jeton d'accès lui-même.
Erreurs d'autorisation
| Code de réponse | Notes |
|---|---|
| 400 | Un en-tête d'autorisation malformé a été fourni |
| 401 | L'en-tête d'autorisation est manquant ou le jeton n'est pas valide ou a expiré. |
Choix d'un type de jeton d'autorisation
En cas d'échec, les en-têtes de réponse contiennent un en-tête WWW-Authenticate qui indique le type de jeton requis pour l'accès.