Browse Articles

Browse Articles

Reach 360 : API d'invitations

Dernière mise à jour de l’article le

Cet article s'applique à :

Reach 360

Ce que fait ce point de terminaison d'API

L'API Invitations vous permet de créer et de supprimer des invitations à Reach 360. Les administrateurs voient cela se refléter en tant qu'utilisateurs dans l'onglet En attente. Les utilisateurs reçoivent des e-mails lorsqu'ils sont invités. Si leur invitation en attente est supprimée avant qu'ils n'aient accepté, le lien de l'e-mail ne fonctionnera pas.

Vous pouvez également utiliser cette API pour récupérer la liste de toutes les invitations en attente ou les détails des invitations pour un utilisateur spécifique.

Points de terminaison

  • POST /invitations—envoyer une invitation à un utilisateur pour qu'il rejoigne votre équipe
  • GET /invitations—répertorier les invitations en attente
  • GET /invitations/{invitationId}—obtenir les détails d'une invitation en attente par numéro d'invitation
  • DELETE /invitations/{invitationId}—supprimer une invitation en attente par numéro d'invitation

Objets d'invitation

  • id(chaîne) - l'identifiant unique de l'invitation
  • email(chaîne) : adresse e-mail de l'invité
  • firstName(chaîne) : prénom de l'invité
  • lastName(chaîne) : nom de famille de l'invité
  • groups(liste de chaînes) : liste des noms de groupes auxquels l'invité doit être affecté
  • url(string) - URL pour récupérer les détails de l'invitation depuis l'API

Créer une invitation

POST /invitations

Paramètres de demande (JSON)

  • email(chaîne, obligatoire) : adresse e-mail de l'utilisateur à inviter
  • firstName(chaîne, facultatif) - prénom de l'utilisateur à inviter
  • lastName(chaîne, facultatif) - nom de famille de l'utilisateur à inviter
  • groups(liste de chaînes, facultatif) : liste des noms de groupes auxquels attribuer l'utilisateur invité. Tous les groupes qui n'existent pas sont créés lorsque l'utilisateur accepte l'invitation.

Exemple de réponse

{
« invitation » : {
« id » : « example-invitation-id »,
 « email » : "foo@example.com «,
 « FirstName » : « Exemple de prénom »,
 « LastName » : « Exemple de nom de famille »,
 « groupes » : ["exemple de groupe a », « exemple de groupe b"]
}
}

Codes d'erreur spécifiques aux terminaux

  • 'user_exists'- impossible de créer une invitation car l'adresse e-mail spécifiée possède déjà un compte
  • 'invite_pending'- impossible de créer une invitation car l'adresse e-mail spécifiée contient déjà une invitation en attente
  • 'max_invites_reached'- Impossible de créer une invitation car vous avez atteint la limite de votre compte d'essai. Veuillez passer à un forfait supérieur ou contacter l'support technique pour augmenter cette limite.

Liste des invitations

GET /invitations

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 100 (50 par défaut)
  • email(chaîne, facultatif) : si cette option est fournie, ne renvoyez que les invitations pour cette adresse e-mail

Exemple de réponse

{
« invitations » : [
{
« id » : « example-invitation-id-1",
 « email » : "foo@example.com «,
 « FirstName » : « Exemple de prénom 1 »,
 « LastName » : « Exemple de nom de famille 1 »,
 « groupes » : ["exemple de groupe a », « exemple de groupe b"]
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Récupérer une invitation par identifiant

GET /invitations/{invitationId}

Exemple de réponse

{
« id » : « example-invitation-id »,
 « email » : "foo@example.com «,
 « FirstName » : « Exemple de prénom »,
 « LastName » : « Exemple de nom de famille »,
 « groupes » : ["exemple de groupe a », « exemple de groupe b"]
}

Codes d'erreur spécifiques aux terminaux

  • 'invitation_not_found'- impossible de récupérer l'invitation car l'invitation n'existe pas

Supprimer les invitations

DELETE /invitations/{invitationId}

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques aux terminaux

  • 'invitation_not_found'- impossible de récupérer l'invitation car l'invitation n'existe pas