Aller au contenu principal

S'authentifier auprès de l'API partenaire

L'API partenaire utilise le flux d'identifiants client OAuth 2.0. Avant de commencer, obtenez votre identifiant client et votre secret client.

Demander un jeton d'accès​

Utilisez l'authentification HTTP Basic et envoyez une requête encodée comme formulaire au point de terminaison des jetons :

curl --request POST "https://api.workstaff.app/oauth/token/" \
--user "$CLIENT_ID:$CLIENT_SECRET" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "grant_type=client_credentials" \
--data-urlencode "scope=staff:read"

La réponse contient le jeton d'accès, sa durée de vie en secondes, son type et les portées accordées :

{
"access_token": "votre-jeton-d-acces",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "staff:read"
}

Demandez un nouveau jeton lorsque le jeton actuel expire.

Choisir les portées​

Demandez uniquement les portées nécessaires à votre intégration :

  • staff:read permet d'afficher la liste des profils du personnel et leurs détails.
  • staff:write permet de créer et de modifier les profils du personnel.

Effectuer votre première requête​

Envoyez le jeton d'accès comme jeton Bearer dans l'en-tête Authorization :

curl "https://api.workstaff.app/partner/v1/staff/" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"

Chaque jeton d'accès appartient à un seul compte Workstaff. Il peut accéder uniquement aux profils du personnel associés à ce compte.