invitations

Endpoint de API para Invitaciones

Descripción

Este endpoint es fundamental para gestionar invitaciones de usuarios, permitiendo que nuevos miembros se unan a la organización con los permisos y roles adecuados.

Al utilizarlo, se envía un correo electrónico al destinatario con las instrucciones para activar su cuenta.

---

Solicitud

Método: POST

URL: https://api-staging.nimbo.app/api/v1/invitations

Encabezados:

• Content-Type: application/json

Cuerpo de la solicitud (JSON)

Debe incluir los siguientes campos:

Estructura de configuration

json

{
  "access_to_clinical": false,
  "access_to_charges": false,
  "custom_roles": {
    "administrator": false,
    "restricted_medic": false,
    "all_agendas": false,
    "access_control": false
  }
}

• Nota para médicos: Todos los valores en custom_roles deben ser false.

---

Respuesta Exitosa

• Código de estado: 201 (Created)

• Cuerpo de la respuesta (JSON):

Response

Cuando la invitación se crea correctamente, la API devuelve:

• Código de estado: 201 (Created)

• Cuerpo de la respuesta (JSON):

• invitation (objeto): Contiene los detalles de la invitación.

  • token (string): Token único vinculado a la invitación. Debe almacenarse, ya que es necesario para confirmar la cuenta.

Example

{
  "invitation": {
    "recipient_email": "string",          // Email address of the recipient
    "recipient_password": "string",       // Password for the recipient's account
    "recipient_name": "string",           // Full name of the recipient
    "invitation_for": "string",           // Type of invitation (e.g., "member")
    "assistant_patient_access": "boolean", // Access level for assistant to patient data
    "configuration": {
      "access_to_clinical": "boolean",    // Access to clinical information
      "access_to_charges": "boolean",      // Access to charge information
      "custom_roles": {
        "administrator": "boolean",         // Role assignment for administrator
        "restricted_medic": "boolean",     // Role assignment for restricted medic
        "all_agendas": "boolean",           // Access to all agendas
        "access_control": "boolean"         // General access control permission
      }
    },
    "create_user": "boolean",              // Flag to indicate if a user should be created
    "organization_id": "string",           // ID of the organization
    "location_id": "string",                // ID of the location
    "physician_specialty_id": "string"     // ID of the physician specialty
  }
}