Proveedores
Gestión de proveedores de servicio (Service Providers). Los proveedores son entidades externas que pueden atender llamadas en la plataforma. Lectura requiere supervisor, escritura requiere manager.
Endpoints
| Método | Endpoint | Descripción | Rol Mínimo |
|---|---|---|---|
GET | /api/v1/providers | Listar proveedores | supervisor |
POST | /api/v1/providers | Crear proveedor | manager |
GET | /api/v1/providers/:id | Buscar proveedor | supervisor |
PUT | /api/v1/providers/:id | Actualizar proveedor | manager |
DELETE | /api/v1/providers/:id | Eliminar proveedor | manager |
GET | /api/v1/providers/:id/users | Listar usuarios del proveedor | supervisor |
POST | /api/v1/providers/:id/users | Asociar usuario al proveedor | manager |
DELETE | /api/v1/providers/:id/users/:user_id | Desasociar usuario | manager |
Listar Proveedores
GET /api/v1/providersQuery Parameters
| Parámetro | Tipo | Predeterminado | Descripción |
|---|---|---|---|
page | integer | 1 | Número de página |
page_size | integer | 20 | Elementos por página |
sort_by | string | name | Campo para ordenamiento |
sort_order | string | asc | Dirección del ordenamiento |
Ejemplo de Request
bash
curl -X GET "https://voki.avanter.com.br/api/v1/providers" \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Respuesta Exitosa (200)
json
{
"data": [
{
"id": "c9d0e1f2-a3b4-5678-ijkl-901234567890",
"name": "Consultoria Médica XYZ",
"document": "98.765.432/0001-10",
"email": "contato@consultoriaxyz.com.br",
"phone": "+5511988887777",
"active": true,
"user_count": 3,
"inserted_at": "2026-01-20T10:00:00Z",
"updated_at": "2026-01-20T10:00:00Z"
}
],
"meta": {
"current_page": 1,
"page_size": 20,
"total_pages": 1,
"total_count": 1
}
}Crear Proveedor
POST /api/v1/providersRequest Body
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
name | string | Sí | Nombre del proveedor |
document | string | No | CNPJ o CPF |
email | string | No | Email de contacto |
phone | string | No | Teléfono |
Ejemplo de Request
bash
curl -X POST https://voki.avanter.com.br/api/v1/providers \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter" \
-H "Content-Type: application/json" \
-d '{
"service_provider": {
"name": "Clínica ABC",
"document": "11.222.333/0001-44",
"email": "contato@clinicaabc.com.br",
"phone": "+5511977776666"
}
}'Respuesta Exitosa (201)
json
{
"data": {
"id": "d0e1f2a3-b4c5-6789-jklm-012345678901",
"name": "Clínica ABC",
"document": "11.222.333/0001-44",
"email": "contato@clinicaabc.com.br",
"phone": "+5511977776666",
"active": true,
"user_count": 0,
"inserted_at": "2026-02-18T14:00:00Z",
"updated_at": "2026-02-18T14:00:00Z"
}
}Buscar Proveedor
GET /api/v1/providers/:idEjemplo de Request
bash
curl -X GET https://voki.avanter.com.br/api/v1/providers/c9d0e1f2-a3b4-5678-ijkl-901234567890 \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Actualizar Proveedor
PUT /api/v1/providers/:idEjemplo de Request
bash
curl -X PUT https://voki.avanter.com.br/api/v1/providers/c9d0e1f2-a3b4-5678-ijkl-901234567890 \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter" \
-H "Content-Type: application/json" \
-d '{
"service_provider": {
"name": "Consultoria Médica XYZ Atualizada",
"active": true
}
}'Eliminar Proveedor
DELETE /api/v1/providers/:idEjemplo de Request
bash
curl -X DELETE https://voki.avanter.com.br/api/v1/providers/d0e1f2a3-b4c5-6789-jklm-012345678901 \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Respuesta Exitosa (204)
Sin cuerpo en la respuesta.
Listar Usuarios del Proveedor
GET /api/v1/providers/:provider_id/usersEjemplo de Request
bash
curl -X GET https://voki.avanter.com.br/api/v1/providers/c9d0e1f2-a3b4-5678-ijkl-901234567890/users \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Respuesta Exitosa (200)
json
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Dr. Carlos Mendes",
"email": "carlos@consultoriaxyz.com.br",
"role": "attendant",
"active": true
}
]
}Asociar Usuario al Proveedor
POST /api/v1/providers/:provider_id/usersRequest Body
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
user_id | uuid | Sí | ID del usuario |
Ejemplo de Request
bash
curl -X POST https://voki.avanter.com.br/api/v1/providers/c9d0e1f2-a3b4-5678-ijkl-901234567890/users \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter" \
-H "Content-Type: application/json" \
-d '{
"user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}'Respuesta Exitosa (201)
json
{
"data": {
"message": "Usuário associado ao fornecedor"
}
}Desasociar Usuario del Proveedor
DELETE /api/v1/providers/:provider_id/users/:user_idEjemplo de Request
bash
curl -X DELETE https://voki.avanter.com.br/api/v1/providers/c9d0e1f2-a3b4-5678-ijkl-901234567890/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Respuesta Exitosa (204)
Sin cuerpo en la respuesta.
