Skip to main content
Este guia prepara você para chamar a API do Admin Service.

​
Pré-requisitos

  • Acesso à base URL da API (ex.: http://localhost:8081 ou http://localhost:8080/admin-service).
  • Credenciais ou headers exigidos pelo ambiente (ex.: header origin).

​
Escolha a base URL

Use http://localhost:8081 quando o Admin Service estiver rodando sozinho. Os paths são /users, /institutions, /protocols, etc.

​
Sua primeira requisição

1

Defina a base URL

Escolha o ambiente (direto ou gateway) e use a URL correspondente em todas as requisições.
2

Inclua o header origin

A maioria dos endpoints exige o header origin. Substitua your-origin pelo valor configurado no seu deployment.
3

Liste usuários

Use um dos exemplos abaixo conforme a base URL escolhida.
curl -X GET "http://localhost:8080/admin-service/users" \
  -H "origin: your-origin"
Se o seu ambiente usar Bearer token ou outros headers de autenticação, adicione-os à requisição (ex.: -H "Authorization: Bearer YOUR_TOKEN").

​
Exemplo: criar um protocolo

Criar um protocolo (path igual com ou sem gateway): 
curl -X POST "http://localhost:8081/protocols" \
  -H "Content-Type: application/json" \
  -H "origin: your-origin" \
  -d '{
    "institutionId": "uuid-da-instituicao",
    "name": "Meu Protocolo",
    "prompt": "Prompt opcional para IA"
  }'

{
  "id": "uuid-do-protocolo",
  "institutionId": "uuid-da-instituicao",
  "name": "Meu Protocolo",
  "prompt": "Prompt opcional para IA",
  "createdAt": "2025-03-09T18:00:00.000Z",
  "updatedAt": "2025-03-09T18:00:00.000Z"
}
Após o 201, use o id retornado para consultar ou atualizar o protocolo na API Reference.

​
Troubleshooting

Verifique se o header origin está presente e com o valor esperado pelo ambiente. Em setups com gateway, confirme que o token ou sessão está sendo repassado corretamente.
Ao chamar de um browser, garanta que o backend permite a origem do front. Em desenvolvimento local, use a base URL correta (serviço direto ou gateway) e porta (ex.: 8081 ou 8080).
Confirme que o institutionId no body existe e que o path está correto: POST /protocols (sem prefixo /admin-service).

​
Próximos passos

API Reference

Endpoints, parâmetros e schemas gerados a partir do OpenAPI.

Introdução

Visão geral dos recursos e base URLs.