Conventions de l'API

Les points de terminaison de l'API partenaire utilisent https://api.workstaff.app/partner/v1/ comme URL de base. Les requêtes et les réponses utilisent le format JSON, sauf indication contraire.

Pagination

Les opérations de liste utilisent une pagination par curseur. La taille de page par défaut est de 100 résultats, et le paramètre page_size permet de demander jusqu'à 500 résultats.

{
  "next": "https://api.workstaff.app/partner/v1/staff/?cursor=valeur-opaque",
  "previous": null,
  "results": []
}

Suivez l'URL next ou previous sans la modifier. Les valeurs de curseur sont opaques. Les clients ne doivent ni les analyser ni les construire. Une valeur null indique qu'il n'existe aucune page dans cette direction.

Erreurs

Les erreurs de l'API partenaire utilisent une structure JSON commune :

{
  "code": "validation_error",
  "message": "The request contains invalid fields.",
  "errors": [
    {
      "field": "name.first_name",
      "code": "blank",
      "message": "This field may not be blank."
    }
  ],
  "correlation_id": "identifiant-de-correlation"
}

Utilisez code et les codes d'erreur des champs pour prendre des décisions programmatiques. Les messages lisibles peuvent changer. Incluez le correlation_id lorsque vous communiquez avec Workstaff au sujet d'une requête échouée.

Limites de requêtes

Les limites s'appliquent séparément à chaque client de l'API partenaire. Si l'API renvoie 429 Too Many Requests, attendez avant de réessayer et respectez l'en-tête de réponse Retry-After.

Mises à jour et valeurs vides

Dans une requête PATCH, les champs omis restent inchangés. La valeur null efface un champ uniquement si ce champ accepte cette valeur. Les tableaux vides utilisent [] et ne sont jamais renvoyés avec la valeur null.