Skip to main content
Version: v1

ATS Partner status API

L'API HelloWork "ATS Partner status API" expose des endpoints HTTP pour mettre à jour le statut des candidatures.

Les requêtes envoyées à l'API doivent être authentifiées.

Authentification

L'authentification se fait en 2 étapes, il a été choisi de passer par un token JWT à passer dans un header.

Récupération d'un token

Pour récupérer un token JWT, il faut envoyer une requête POST sur le endpoint /v1/signin.

Il s'agit d'une requête http POST sur le endpoint /v1/signin

Le body du message doit être au format suivant :

{
"username": "ATS_username",
"password": "abcdefghijklmnopqrstuvwxyz"
}

Les champs username et password sont transmis par HelloWork à la création du compte.

En cas d'authentification réussie, la réponse HTTP est au statut 200 avec le format suivant :

{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Le token renvoyé est valide pour une durée d'une heure et ne doit être renouvelé que lorsqu'il devient invalide.

Lorsque le token n'est plus valide, une erreur est remontée avec le statut 401 au format suivant :

{
"statusCode": 401,
"code": "FST_JWT_AUTHORIZATION_TOKEN_EXPIRED",
"error": "Unauthorized",
"message": "Authorization token expired"
}
info

Le fichier de description OpenAPI peut être consulté et utilisé ici.

Utilisation du token

Une fois le token récupéré, il est à inclure dans chaque requête en header au format suivant :

authorization: Bearer {token}