Le portail pour les intégrations Nos Gestes Climat est une interface administrateur sur laquelle un partenaire externe peut venir configurer son intégration. Pour le moment, le portail permet une fonctionnalité d’ETL (Extract. Transform, Load): transformer de la donnée brute résultat de test nos gestes climat vers un autre format désiré mais nous souhaitons faire évoluer ce portail avec d’autres fonctionnalités dans l’avenir.
Afin de bénéficier du portail intégration. Il suffit de contacter l’équipe nos gestes climat par email ([email protected]) pour créer votre scope et faire whitelister son email ou le domaine email de son organisation, puis de se rendre sur la page swagger https://server.nosgestesclimat.fr/integrations-api/docs/
Un environnement de preprod est aussi disponible https://server.preprod.nosgestesclimat.fr/integrations-api/docs/
<aside> 💡
Si vous effectuez des tests sur l’environnement de preprod, merci d’utiliser le swagger ou de rajouter un header Origin https://server.preprod.nosgestesclimat.fr à chaque requête curl ci dessous
</aside>
Pour effectuer des requêtes sur le portail, la première étape est de s’authentifier. Pour cela, vous pouvez utiliser la requête suivante
curl --location '<https://server.nosgestesclimat.fr/integrations-api/v1/tokens>' \\
--header 'Content-Type: application/json' \\
--data-raw '{"email":"< votre email ici >"}'
La réponse est une 201 Created avec un message
{
"message": "If you are registered as a Nos Gestes Climat API user, an email has been sent to you. Please follow its instructions to recover your API token"
}
Un email vous est envoyé si vous avez bien whitelisté votre email ou le domaine de votre email auprès de nos équipes. Sinon aucun email ne sera envoyé mais la réponse sera toujours un succès.
L’email contient un lien qui effectue la requête suivante
curl --location '<https://server.nosgestesclimat.fr/integrations-api/v1/tokens?email=>< votre email ici >&code=< code de verification du serveur >'
Le code est valide une heure. Si vous récupérez votre jeton avant ce délai la réponse du serveur sera une 200 OK avec votre accessToken et un refreshToken.
{
"token": "<votre accessToken ici>",
"refreshToken": "<votre refreshToken ici>"
}
Passé ce délai, la réponse sera une 404 Not Found
"VerificationCode not found"