Environnements
Deux environnements distincts sont à votre disposition :
| Environnement | API | Documentation | Valeur légale |
|---|---|---|---|
| Test | https://staging.ecmr.fincargo.ai |
https://docs.staging.ecmr.fincargo.ai |
Aucune : les documents créés ici n'ont aucune portée légale |
| Production | https://ecmr.fincargo.ai |
https://docs.ecmr.fincargo.ai |
Pleine valeur légale |
Validez systématiquement votre intégration en test avant de passer en
production. Les comptes, les clés API (sk_test_… en test, sk_live_… en
production) et les clients OAuth2 sont distincts entre les deux
environnements et ne sont jamais interchangeables.
Obtenir un compte de test
- Inscrivez votre entreprise sur la console Fincargo de l'environnement de test, puis créez une clé API ou un client OAuth2 dans Hub (la grille de l'en-tête) → Intégrations → Clés API (voir Authentification).
- Le DeCa est un module : il doit être activé sur votre compte. Tant qu'il
ne l'est pas, la création d'un DeCa est refusée avec
account.module_not_enabled(403). Demandez son activation à votre contact Fincargo.
Ce qu'il faut savoir sur l'environnement de test
- Il évolue plus vite que la production : il reçoit les nouveautés avant elle. Le changelog dit ce qui change.
- Les SMS et les e-mails y sont réellement envoyés. Utilisez uniquement des numéros et des adresses qui vous appartiennent.
- Ce que fait le chauffeur (déclarer le camion, terminer le transport) passe par l'application chauffeur : en test, créez un chauffeur sur votre compte et utilisez l'application avec lui.
- La documentation interactive (Swagger, qui envoie de vraies requêtes depuis
votre navigateur) n'existe qu'ici :
https://staging.ecmr.fincargo.ai/docs.
Le contrat OpenAPI
Le schéma OpenAPI est publié dans les deux environnements, à l'adresse de l'API, avec une page de lecture :
| Schéma | Lecture | |
|---|---|---|
| Test | https://staging.ecmr.fincargo.ai/openapi.json |
https://staging.ecmr.fincargo.ai/redoc |
| Production | https://ecmr.fincargo.ai/openapi.json |
https://ecmr.fincargo.ai/redoc |
Générez votre client à partir du schéma de l'environnement que vous appelez.