Zscan Evo Local API

Bem-vindo à documentação oficial da API Local do Zscan Evo.

Esta interface permite integração segura e direta com o software Zscan Evo, possibilitando acesso e manipulação de módulos, dados armazenados e informações de usuários.

Status: Active
Última atualização: 2024-10-29
Protocolo: HTTPS / JSON

🚀 Getting Started

A API funciona localmente e segue os princípios RESTful.
Todas as comunicações devem ser realizadas via HTTPS e retornam dados no formato JSON.

Base URL

https://localhost:4514/api/v1/

🔐 Authentication

O acesso à API é protegido por Bearer Token.
O token é temporário (validade de 24 horas) e deve ser gerado antes de qualquer outra operação.

1. Gerar Token de Acesso

Método: POST /api/auth

Resposta de sucesso (exemplo):

{
  "id": 1,
  "login": "doctor",
  "token": "your_bearer_token_here"
}

default:
description: Usando o Token
Em todas as demais requisições, inclua o token no header:
authorization: Bearer your_bearer_token_here

🛠️ Recursos Disponíveis

A API oferece controle completo sobre os principais módulos do sistema:

Recurso	Descrição	Endpoint principal	Métodos suportados
patient	Gerenciamento completo de fichas de pacientes	/patient	GET, POST, PUT, DELETE
report	Consulta e manipulação de laudos médicos	/report	GET, DELETE
imagem	Acesso e upload de imagens de exames	/image	GET, POST, PUT, DELETE
exame	Gerenciamento de tipos de exames	/exam	GET, POST, PUT
unidade	Cadastro e consulta de unidades de saúde	/unit	GET, POST
dados_clinica	Dados institucionais da clínica	/clinic	GET

dicas para integração:
Para sistemas externos, recomenda-se utilizar o campo externalId ao criar ou atualizar registros (pacientes, consultas, etc.) para facilitar a sincronização entre bases de dados.

⚠️ Códigos de Resposta

A API utiliza os códigos HTTP padrão:

Código	Significado
200	OK – Requisição processada com sucesso
401	Unauthorized – Falha na autenticação
404	Not Found – Rota ou dado não encontrado
500	Internal Server Error – Erro no servidor

📞 Suporte

Dúvidas sobre integração?
Autores: Guilherme Santos
sistema: Zscan Software
documentação gerada automaticamente com base na versão de 2024-10-29.

Introdução

Zscan Evo Local API#

🚀 Getting Started#

Base URL#

🔐 Authentication#

1. Gerar Token de Acesso#

🛠️ Recursos Disponíveis#

⚠️ Códigos de Resposta#

📞 Suporte#