Skip to content

Fournisseurs

Gestion des fournisseurs de services (Service Providers). Les fournisseurs sont des entités externes pouvant prendre en charge des appels sur la plateforme. La lecture nécessite le rôle supervisor, l'écriture nécessite le rôle manager.

Endpoints

MéthodeEndpointDescriptionRôle Minimum
GET/api/v1/providersLister les fournisseurssupervisor
POST/api/v1/providersCréer un fournisseurmanager
GET/api/v1/providers/:idRechercher un fournisseursupervisor
PUT/api/v1/providers/:idMettre à jour un fournisseurmanager
DELETE/api/v1/providers/:idSupprimer un fournisseurmanager
GET/api/v1/providers/:id/usersLister les utilisateurs du fournisseursupervisor
POST/api/v1/providers/:id/usersAssocier un utilisateur au fournisseurmanager
DELETE/api/v1/providers/:id/users/:user_idDissocier un utilisateurmanager

Lister les Fournisseurs

GET /api/v1/providers

Query Parameters

ParamètreTypeDéfautDescription
pageinteger1Numéro de page
page_sizeinteger20Éléments par page
sort_bystringnameChamp de tri
sort_orderstringascDirection du tri

Exemple de Requête

bash
curl -X GET "https://voki.avanter.com.br/api/v1/providers" \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter"

Réponse de Succès (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
  }
}

Créer un Fournisseur

POST /api/v1/providers

Request Body

ChampTypeObligatoireDescription
namestringOuiNom du fournisseur
documentstringNonCNPJ ou CPF
emailstringNonEmail de contact
phonestringNonTéléphone

Exemple de Requête

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"
    }
  }'

Réponse de Succès (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"
  }
}

Rechercher un Fournisseur

GET /api/v1/providers/:id

Exemple de Requête

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"

Mettre à Jour un Fournisseur

PUT /api/v1/providers/:id

Exemple de Requête

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
    }
  }'

Supprimer un Fournisseur

DELETE /api/v1/providers/:id

Exemple de Requête

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"

Réponse de Succès (204)

Pas de corps dans la réponse.


Lister les Utilisateurs du Fournisseur

GET /api/v1/providers/:provider_id/users

Exemple de Requête

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"

Réponse de Succès (200)

json
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Dr. Carlos Mendes",
      "email": "carlos@consultoriaxyz.com.br",
      "role": "attendant",
      "active": true
    }
  ]
}

Associer un Utilisateur au Fournisseur

POST /api/v1/providers/:provider_id/users

Request Body

ChampTypeObligatoireDescription
user_iduuidOuiID de l'utilisateur

Exemple de Requête

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"
  }'

Réponse de Succès (201)

json
{
  "data": {
    "message": "Utilisateur associé au fournisseur"
  }
}

Dissocier un Utilisateur du Fournisseur

DELETE /api/v1/providers/:provider_id/users/:user_id

Exemple de Requête

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"

Réponse de Succès (204)

Pas de corps dans la réponse.

Documentação da API Voki v4.0