Qué hace este punto final de API

Con la API de invitaciones, puede crear y eliminar invitaciones a Reach 360. Los administradores ven esto reflejado como usuarios en la pestaña Pendientes. Los usuarios reciben correos electrónicos cuando se les invita. Si la invitación pendiente se elimina antes de que la acepten, el enlace de correo electrónico no funcionará.

También puedes usar esta API para recuperar una lista de todas las invitaciones pendientes o los detalles de las invitaciones de un usuario específico.

• Puntos finales
• Objetos de invitación
• Crear invitación
• Lista de invitaciones
• Recupera la invitación por ID
• Eliminar invitaciones

Puntos finales

• POST /invitations—envía una invitación a un usuario para que se una a tu equipo
• GET /invitations—enumerar las invitaciones pendientes
• GET /invitations/{invitationId}—obtener los detalles de una invitación pendiente mediante el identificador de la invitación
• DELETE /invitations/{invitationId}—eliminar una invitación pendiente mediante el identificador de invitación

Objetos de invitación

• id(cadena): el identificador único de la invitación
• email(cadena): la dirección de correo electrónico del invitado
• firstName(cadena): nombre del invitado
• lastName(cadena): apellido del invitado
• groups(lista de cadenas): una lista de nombres de grupos a los que se debe asignar el invitado
• url(cadena): URL para obtener los detalles de la invitación desde la API

Crear invitación

POST /invitations

Parámetros de solicitud (JSON)

• email(cadena, obligatorio): correo electrónico del usuario al que se va a invitar
• firstName(cadena, opcional): nombre del usuario al que se va a invitar
• lastName(cadena, opcional): apellido del usuario al que se va a invitar
• groups(lista de cadenas, opcional): lista de nombres de grupos a los que asignar el usuario invitado. Los grupos que no existen se crean cuando el usuario acepta la invitación.

Ejemplo de respuesta

{
«invitation»: {
«id»: «example-invitation-id», 
 «email»: "foo@example.com «, «firstName»: 
 «Ejemplo de nombre», «lastName»: 
 «Ejemplo de apellido», 
 «groups»: ["ejemplo grupo a», «ejemplo grupo b"]}} 
 

Códigos de error específicos de Endpoint

• 'user_exists'- no se puede crear una invitación porque la dirección de correo electrónico especificada ya tiene una cuenta
• 'invite_pending'- no puede crear una invitación porque la dirección de correo electrónico especificada ya tiene una invitación pendiente
• 'max_invites_reached'- no puedes crear una invitación porque has alcanzado el límite de tu cuenta de prueba. Actualiza tu plan o contacta al soporte técnico para aumentar este límite.

Haz una lista de invitaciones

GET /invitations

Parámetros de solicitud (cadena de consulta)

• limit(entero, opcional): el número máximo de resultados que se devolverán en una sola respuesta (consulte Paginación); debe estar entre 1 y 100 (el valor predeterminado es 50)
• email(cadena, opcional): si se proporciona, solo devuelve las invitaciones de esta dirección de correo electrónico

Ejemplo de respuesta

{
«invitaciones»: [
{
«id»: «example-invitation-id-1", 
 «email»: "foo@example.com «, «firstName»: 
 «Ejemplo de nombre 1", «lastName»: 
 «Ejemplo de apellido 1", «groups»: ["ejemplo grupo a», 
 «ejemplo grupo b"]},... 
 
], «nextURL»: "https://url-for-next-page-of-results"} 
 

Recupera la invitación por ID

GET /invitations/{invitationId}

Ejemplo de respuesta

{
«id»: «example-invitation-id», 
 «email»: "foo@example.com «, 
 «firstName»: «Ejemplo de nombre», «lastName»: 
 «Ejemplo de apellido», 
 «groups»: ["ejemplo grupo a», «ejemplo grupo b"]} 

Códigos de error específicos de Endpoint

• 'invitation_not_found'- no se puede recuperar la invitación porque la invitación no existe

¿Eliminar invitaciones

DELETE /invitations/{invitationId}

Respuesta de éxito

204 «Sin contenido»

Códigos de error específicos de un terminal

• 'invitation_not_found'- no se puede recuperar la invitación porque la invitación no existe