Guia API SalusWeb

INTRODUÇÃO

Este guia serve para auxilio aos programadores parceiros à utilizarem a API RestFull fornecido pela Neovita em sua aplicação Salus.

O usuário que irá consumir a API precisa ser um usuário registrado tanto na base de teste para os devidos testes quanto na base de produção para a utilização da aplicação Salus a nível de produção.

Entre em contato conosco para que possamos registrar um acesso na base de teste e lhe encaminhar as informações para que possa desenvolver e testar seus códigos.

AUTENTICAÇÃO

Para o consumo de qualquer consulta ou realizar algum regitro através da API RestFull, primeiramente será necessário autenticar o usuário registrado e recuperar seu Access Token.

Gerar Token de acesso com os parâmetros de email e password enviados ao endpoint via verbo http POST.

ENDPOINT
POST:
https://www.hlagyn.neovita.com.br/api/v1/auth?email={email}&password={password}

HEADERS
{
     “Content-Type”: “application/json”,
     “Accept”: “application/json”,
}

PARÂMETROS
{
     “email”: “{email}”,
     “password”: “{password}”,
}

TOKEN RETORNADO Status 200
{
     "token": “{tokendeacessoparaconsumoaossendpointsdaapi}”
}

LISTAR DE PEDIDOS

Retornar a lista dos pedidos de exames realizados pela instituição.

Acesso ao endpoint via verbo GET com o parâmetro HEADER autozation: Bearer {tokenrecebidonaautenticacao}

O parâmetro token é obrigatório para a devida autorização de acesso, os demias campos são para filtrar as consultas.

ENDPOINT
GET:
https://www.hlagyn.neovita.com.br/api/v1/pedidos?par1={par1}&&parN={parN}

HEADERS
{
     “Content-Type”: “application/json”,
     “Accept”: “application/json”,
     “Autorization”: “{token}”,
}

PARÂMETROS
{
     “situacao”: “{ }”,      // possíveis situações listadas na obs abaixo
     “nome”: “{ }”,      // filtra pelo nome do paciente
     “data_req_inicio”: “{ }”,      // filtra pelo intervalo entre data inicial
     “data_req_final”: “{ }”,      // e data final da requisição
     “data_liberacao_inicio”: “{ }”,      // filtra pelo intervalo entre data inicial
     “data_liberacao_final”: “{ }”,      // e data final da liberação do exame
}

DADOS RETORNADOS Status 200
{
     "total": “{ }”
     "per_page": “{ }”
     "last_page": “{ }”
     "current_page": “{ }”
     "next_page_url": “{ }”
     "prev_page_url": “{ }”
     "data": [
         {
             "nome": "{ }"
             "situacao": "{ }"
             "requisicao": "{ }"
             "data_requisicao": "{ }"
             "hora_requisicao": "{ }"
             "data_liberacao": "{ }"
             "hora_liberacao": "{ }"
             "resultado": "{ }"
             "lote_triagem": "{ }"
             "data_triagem": "{ }"
             "hora_triagem": "{ }"
             "valor_resultado": "{ }"
             "metodo": "{ }"
             "material": "{ }"
         },
         ...
    ]
}

Os parâmetros "total", "per_page", "last_page", "current_page", "next_page_url" e "prev_page_url" servem para axiliar na paginação dos resultados, podendo enviá-los como parâmetros de consulta.

RETORNAR PEDIDO ESPECÍFICO

Para o retorno do pedido de exame específico, basta enviar o número da requisição como parâmetro, além do token de autorização.

ENDPOINT
GET:
https://www.hlagyn.neovita.com.br/api/v1/pedido?par1={par1}&&parN={parN}

HEADERS
{
     “Content-Type”: “application/json”,
     “Accept”: “application/json”,
     “token”: “{token}”,
}

PARÂMETROS
{
     “requisicao”: “{requisicao}”
}

DADOS RETORNADOS Status 200
{
     "nome": “{ }”
     "situacao": “{ }”
     "requisicao": “{ }”
     "data_requisicao": “{ }”
     "hora_requisicao": “{ }”
     "data_liberacao": “{ }”
     "hora_liberacao": “{ }”
     "resultado": “{ }”
     "lote_triagem": “{ }”
     "data_triagem": “{ }”
     "hora_triagem": “{ }”
     "valor_resultado": “{ }”
     "metodo": “{ }”
     "material": “{ }”
}

REGISTRAR PEDIDO

Insere Pedidos. Acesso ao endpoint via verbo http POST com header autorization: Bearer {tokenrecebidonaautenticacao}.

ENDPOINT
GET:
https://www.hlagyn.neovita.com.br/api/v1/pedido?par1={par1}&&parN={parN}

HEADERS
{
     “Content-Type”: “application/json”,
     “Accept”: “application/json”,
     “token”: “{token}”,
}

PARÂMETROS
{
     “nome”: “{ }”,      // obrigatório
     “data_nascimento”: “{ }”,      // obrigatório, formato dd/mm/YYYY
     “sexo”: “{ }”,      // obrigatório, "M" ou "F"
     “nome_mae”: “{ }”,      // obrigatório
     “cpf”: “{ }”,
     “rg”: “{ }”,
     “orgao_expedidor”: “{ }”,
     “outro_documento”: “{ }”,
     “celular”: “{ }”,      // obrigatório, formato 99-99999-9999
     “telefone”: “{ }”,      // obrigatório, formato 99-9999-9999
     “email”: “{ }”,      // email válido
     “endereco”: “{ }”,
     “complemento”: “{ }”,
     “numero”: “{ }”,
     “bairro”: “{ }”,
     “cidade”: “{ }”,
     “uf”: “{ }”,      // formato UF
     “cep”: “{ }”,
     “sintomatico”: “{ }”,      // boolean
     “data_inicio_sintomas”: “{ }”,      // não obrigatório, formato dd/mm/YYYY
     “sintomas”: “{ }”,      // lista["sintoma1", "sintoma2", "..."]
     “outros_sintomas”: “{ }”,
     “data_coleta”: “{ }”,      // obrigatório, formato dd/mm/YYYY
     “numero_amostra”: “{ }”,      // obrigatório
     “material_coletado”: “{ }”,      // lista ["material1", "material2", "..."]
     “responsavel_coleta”: “{ }”,      // obrigatório
     “responsavel_cadastro”: “{ }”,      // obrigatório
     “obs”: “{ }”,
}

DADOS RETORNADOS Status 201
{
     "requisicao": “{ }”      // retorna a requisicao do pedido inserido
}