API do ImageMais PACS
A mesma API que as telas do sistema usam, para o seu sistema cadastrar pacientes, consultar e acompanhar os exames e os laudos da clínica.
Endereço
https://api-endosystem.imagemais.com.brComo começar
Peça um usuário para a integração
O administrador da clínica cria um usuário só para o seu sistema, num grupo com apenas as permissões que ele precisa. Tudo o que a integração fizer fica registrado em nome desse usuário.
Entre e guarde o token
POST /api/auth/login com o e-mail e a senha devolve o access_token, que vale 3 horas.
Mande o token em toda chamada
No cabeçalho Authorization: Bearer {access_token}. Renove em POST /api/auth/refresh antes de vencer; vencido, entre de novo.
curl -X POST "https://api-endosystem.imagemais.com.br/api/auth/login" \
-H "Content-Type: application/json" \
-d '{"email":"integracao@clinica.com.br","password":"sua-senha"}'Os detalhes estão em Autenticação.
Convenções
- Toda chamada é HTTPS e troca JSON (Content-Type: application/json).
- Os ids são UUID, como 9d3f1c2a-6b7e-4a8d-9f01-23456789abcd.
- Data sem hora vai e volta como AAAA-MM-DD; data com hora volta em ISO 8601, com o fuso.
- Cada usuário só enxerga os dados da própria clínica. Um id de outra clínica responde 404, como se não existisse.
- Nomes de pacientes e endereços são gravados em maiúsculas.
- Os links de arquivos (imagens, vídeos, PDFs, assinaturas, logos) expiram em até 6 horas. Use logo depois de receber e não guarde: quando precisar de novo, peça o registro outra vez. Nos arquivos do exame, url identifica o arquivo e view_url é o link que abre.
Erros
Todo erro volta em JSON, com error dizendo o que houve e, quando ajuda a decidir o que fazer, um code fixo:
{
"error": "Token expirado",
"message": "Sua sessão expirou. Faça login novamente.",
"code": "TOKEN_EXPIRED"
}| Status | Quando |
|---|---|
| 400 | Faltou um campo, ou um valor está fora do formato. A mensagem diz qual. |
| 401 | Sem token (TOKEN_MISSING), token vencido (TOKEN_EXPIRED), inválido (TOKEN_INVALID) ou usuário/clínica desativados (ACCESS_REVOKED). |
| 403 | O grupo do usuário não tem a permissão da rota (sem_permissao), ou a clínica não contratou a funcionalidade (FEATURE_NOT_ENABLED). |
| 404 | O registro não existe, foi excluído ou é de outra clínica. |
| 429 | Passou do limite de chamadas da rota. Espere alguns segundos e tente de novo. |
| 500 | Erro no servidor. Se repetir, avise o suporte com o horário da chamada. |