Authentification

Demandez un jeton d'accès machine à machine et utilisez-le en toute sécurité avec les endpoints API OmniLab approuvés.

2 min de lecture

Votre backend échange ses identifiants client contre un jeton, puis envoie ce jeton à chaque appel.

Avant de commencer

  • Un client_id, un client_secret et une audience pour chaque environnement. Ils ne sont pas en libre-service : demandez-les à votre Customer Success Manager, et faites-vous confirmer les endpoints activés pour vous.
  • Votre hôte API pour chaque environnement, listé dans URL de base et environnements.
  • Un serveur que vous contrôlez pour la demande de jeton, jamais du code navigateur ni le bundle d'une app mobile.

Demander un jeton

  1. Stockez séparément les identifiants de production et de staging, dans un gestionnaire de secrets.

  2. Appelez POST https://<api-host>/v1/oauth:token avec un corps JSON :

    curl -X POST "https://<api-host>/v1/oauth:token" \
      -H "Content-Type: application/json" \
      -d '{
        "client_id": "YOUR_CLIENT_ID",
        "client_secret": "YOUR_CLIENT_SECRET",
        "audience": "YOUR_AUDIENCE",
        "grant_type": "client_credentials"
      }'
    
  3. Lisez le jeton dans la réponse :

    {
      "access_token": "YOUR_ACCESS_TOKEN",
      "token_type": "Bearer",
      "expires_in": 3600
    }
    

    expires_in est la durée de vie du jeton, en secondes. Une nouvelle demande pendant sa validité peut renvoyer le même jeton, avec le même expires_in : mettez donc le jeton en cache, et calculez son expiration à partir de la première réponse.

  4. Envoyez le jeton dans l'en-tête Authorization de chaque requête API :

    Authorization: Bearer YOUR_ACCESS_TOKEN
    

Quand une demande de jeton ou un appel échoue

RéponseCauseQue faire
400 sur la demande de jetonIl manque client_id ou client_secretEnvoyez les deux, puis réessayez
500 sur la demande de jetonLes identifiants ont été refusés, ou aucun jeton n'a pu être émisVérifiez les identifiants et l'audience avant de réessayer
401 sur un appel APILe jeton est absent, expiré ou mal formé, ou appartient à l'hôte d'un autre compteDemandez un nouveau jeton, puis réessayez une fois

Un jeton ne fonctionne que sur l'hôte API du compte pour lequel il a été émis.

Règles de sécurité essentielles

  • N'exposez jamais le client_secret dans du JavaScript navigateur, une page de borne ou le bundle d'une app mobile.
  • Gardez l'échange de jeton sur votre propre backend, puis appelez l'API de serveur à serveur.
  • Stockez des identifiants distincts par environnement.
  • Demandez à votre Customer Success Manager de renouveler les identifiants compromis ou qui ne servent plus.
  • Journalisez de votre côté les ID de requête et les horodatages, mais jamais les secrets complets ni les jetons d'accès complets.

Étapes suivantes

Sur cette page