Migrer vers les API V2¶

De nouvelles API voient le jour pour permettre notamment une gestion unifiée de vos produits cuivre et fibre. Ces API v2 remplacent les API v1 désormais dépréciées. Vous trouverez ci-dessous un tableau de correspondance pour mieux appréhender les changements à réaliser.

Sur les environnements Sandbox et Production¶

V1	V2
api/orders/	api/v2/orders/
api/fiber-orders/	api/v2/orders/
api/services/	api/v2/services/
api/fiber-services/	api/v2/services/
api/actions/	api/v2/services/{service_uuid}/actions/
api/appointment/	api/v2/orders/{order_uuid}/appointment/
api/appointment/	api/v2/appointment/slots/

Sur l'environnement Sandbox uniquement¶

V1	V2
api/scenarios/	api/v2/orders/{order_uuid}/scenarios
api/scenarios/	api/v2/orders/{order_uuid}/scenarios/run/
api/fiber-scenarios/	api/v2/orders/{order_uuid}/scenarios/
api/fiber-scenarios/	api/v2/orders/{order_uuid}/scenarios/run/

Authentification JWT v2¶

L'authentification aux API v2 se fait désormais via des jetons JWT (JSON Web Token). Voici comment obtenir et utiliser ces jetons avec les nouvelles URLs :

Obtenir un jeton d'accès (login)¶

Envoyez une requête POST à l'URL suivante :

POST /api/v2/account/token/

Avec le corps suivant (JSON) :

{
  "email": "votre_email@example.com",
  "password": "votre_mot_de_passe"
}

En cas de succès, la réponse contiendra :

{
  "refresh": "<refresh_token>",
  "access": "<access_token>",
  "token": "<access_token>"
}

Le champ access (ou token) doit être utilisé dans l'en-tête Authorization de vos requêtes API :

Authorization: Bearer <access_token>

Vérifier un jeton¶

Pour vérifier la validité d'un jeton JWT :

POST /api/v2/account/token/verify/

Avec le corps :

{
  "token": "<access_token>"
}

Rafraîchir un jeton¶

Pour obtenir un nouveau jeton d'accès à partir d'un refresh token :

POST /api/v2/account/token/refresh/

Avec le corps :

{
  "refresh": "<refresh_token>"
}

La réponse contiendra un nouveau access_token.

Gestion des cookies¶

Lors de l'authentification, un cookie jwt_token est également posé pour faciliter l'accès cross-domain.

Note

Les anciennes URLs d'authentification ne sont plus supportées en v2. Utilisez exclusivement les endpoints ci-dessus pour l'authentification JWT.

Résumé des endpoints JWT v2¶

Action	URL
Obtenir un jeton d'accès	/api/v2/account/token/
Vérifier un jeton	/api/v2/account/token/verify/
Rafraîchir un jeton	/api/v2/account/token/refresh/