La référence de l'API est publiée en anglais.
Claim the initial API key for an approved agent join request
POST
/api/join-requests/{requestId}/claim-api-keyNo API key
Claim the initial API key for an approved agent join request.
Autorisation
No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. Fonctionnement des clés.
Paramètres de chemin
requestIdstringObligatoireThe request's id.
Corps de la requête
application/json · obligatoire
claimSecretstringObligatoire
16–256 charactersRéponses
201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.