API docs by Redocly

API Conecta Médico (1.0.0)

Download OpenAPI specification:Download

Suporte Técnico: [email protected] URL: https://conectamedico.com.br/contato/

Introdução

A API Conecta médico possibilita a conexão entre nosso software de saúde e nossos parceiros, viabilizando o acesso rápido aos dados em seus sistemas. Com ela, a experiência dos usuários é potencializada ao integrar funcionalidades do nosso software de maneira automatizada.

Requisitos de acesso à API Conecta Médico

Para acessar a API Conecta Médico, é necessário seguir os seguintes requisitos:

  • Solicitar credenciais: Entre em contato com o nosso time (atendimento@conectamedico.com.br) para solicitar as credenciais de acesso. Você receberá um username e um password, que deverão ser utilizados para autenticar as requisições.
  • Autenticação: A autenticação para todas as requisições à API Conecta Médico é feita utilizando o método Bearer Token.

Regras e Premissas

  • Modelo de Comunicação: O formato de requisição da sua API Conecta Médico é baseado em REST (Representational State Transfer). Isso significa que as solicitações são feitas por meio dos métodos HTTP, como GET, POST, PUT e DELETE, para interagir com os recursos da API.

  • Codificação de caracteres: O conteúdo retornado pela API Conecta Médico segue a codificação UTF-8. Certifique-se de configurar corretamente a codificação UTF-8 ao manipular as respostas da API para evitar problemas de caracteres especiais.

  • Comunicação segura: Toda comunicação com a API Conecta Médico deve ser feita por meio de conexões seguras utilizando HTTPS.

  • Stateless: A API Conecta Médico é projetada como stateless, o que significa que cada requisição é independente e não mantém estado entre as solicitações.

  • Formato de dados (content-type): A API Conecta Médico utiliza o formato JSON (JavaScript Object Notation) para as requisições e respostas. Certifique-se de enviar e receber os dados no formato adequado.

  • Códigos HTTP: A API Conecta Médico retorna códigos HTTP para indicar o status da requisição. Alguns dos principais códigos são:

    • 200: Esta requisição foi bem sucedida
    • 400: Dados fornecidos na requisição são inválidos
    • 401: Credenciais utilizadas são inválidas
    • 403: Credenciais utilizadas não têm permissão de acesso ao conteúdo
    • 404: Não encontrado
    • 500: Ocorreu um problema interno no servidor. Tente novamente em breve. Se o erro persistir, entre em contato com o suporte para obter assistência.

Login

Autenticação para usar api

Solicitar token de acesso

Solicitação do token de acesso. Temos 2 opções

  • 1: Por padrão o token vem com validade de 7 dias.
  • 2: Temos a opção de deixar o token com validade de 10 min
Authorizations:
basicAuth
Request Body schema: application/json
username
required
string (Usuário.)

Usuário enviado pela a conecta.

password
required
string (Senha.)

Senha enviado pela a conecta.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "token": "string",
  • "user_email": "string",
  • "user_nicename": "string",
  • "user_display_name": "string"
}

Pacientes

Tudo sobre seus Pacientes

Busca de pacientes

Este endpoint é para trazer dados de um paciente.

Authorizations:
basicAuth
path Parameters
cpf
required
string

CPF do paciente

Responses

Response samples

Content type
application/json
{
  • "id": 45530,
  • "name": "Vinicius Brito",
  • "username": "string",
  • "email": "[email protected]",
  • "status": "string",
  • "page_id": "string",
  • "parceiro": "string",
  • "celular": "string",
  • "cep": "string",
  • "rua": "string",
  • "numero_endereco": "string",
  • "complemento": "string",
  • "bairro_endereco": "string",
  • "cidade": "string",
  • "estado": "string",
  • "sexo": "string",
  • "datanasc": "25/03/1993",
  • "google_userid": "string",
  • "teleinterconsulta_cadastro": "string",
  • "token_user": "string",
  • "teleinterconsulta_senha_configurada": "string",
  • "whatsapp": "string",
  • "email_ofuscado": "string"
}

Cadastro de pacientes

Este endpoint é para fazer um cadastro de paciente.

Authorizations:
basicAuth
Request Body schema: application/json
cpf
required
string (CPF do Paciente.)
matricula
string (Matricula do paciente)
nome
required
string (Nome do paciente)

Nome completo do paciente

sobrenome
string (Sobrenome do paciente)
email
required
string (Email do paciente)

Identificador único que permite localizar um determinado paciente através de um determinado email.

senha
string (Senha do paciente)
celular
required
string
cep
required
string
rua
required
string
numero
required
string
complemento
string
bairro
required
string
cidade
required
string
estado
required
string
sexo
string

Identificação do sexo do paciente:

  • m = Masculino
  • f = Feminino
  • prefere_nao_informar = Não Informado
data_nascimento
required
string

Responses

Request samples

Content type
application/json
{
  • "cpf": 17052897890,
  • "matricula": "string",
  • "nome": "Vinicius Brito",
  • "sobrenome": "string",
  • "email": "[email protected]",
  • "senha": "string",
  • "celular": "string",
  • "cep": "string",
  • "rua": "string",
  • "numero": "string",
  • "complemento": "string",
  • "bairro": "string",
  • "cidade": "string",
  • "estado": "string",
  • "sexo": "string",
  • "data_nascimento": "25/03/1993"
}

Response samples

Content type
application/json
{
  • "id": 45530,
  • "name": "Vinicius Brito",
  • "username": "string",
  • "email": "[email protected]",
  • "status": "string",
  • "page_id": "string",
  • "parceiro": "string",
  • "celular": "string",
  • "cep": "string",
  • "rua": "string",
  • "numero_endereco": "string",
  • "complemento": "string",
  • "bairro_endereco": "string",
  • "cidade": "string",
  • "estado": "string",
  • "sexo": "string",
  • "datanasc": "25/03/1993",
  • "google_userid": "string",
  • "teleinterconsulta_cadastro": "string",
  • "token_user": "string",
  • "teleinterconsulta_senha_configurada": "string",
  • "whatsapp": "string",
  • "email_ofuscado": "string"
}

Dependentes

Tudo sobre os dependentes

Cadastro de dependente

Este endpoint é para fazer um cadastro de dependente.

Authorizations:
basicAuth
header Parameters
Tokenconecta
required
string
Example: JWT: 123456

user_token do paciente

Request Body schema: application/json
cpf
required
string (CPF do Dependente.)
nome
required
string (Nome do dependente)

Nome completo do dependente

matricula
string (Matricula do dependente)
celular
string
cep
required
string
numero
required
string
endereco
required
string
bairro
required
string
cidade
required
string
estado
required
string
data_nascimento
required
string

Responses

Request samples

Content type
application/json
{
  • "cpf": 17052897890,
  • "nome": "Vinicius Brito",
  • "matricula": "string",
  • "celular": "string",
  • "cep": "string",
  • "numero": "string",
  • "endereco": "string",
  • "bairro": "string",
  • "cidade": "string",
  • "estado": "string",
  • "data_nascimento": "25/03/1993"
}

Response samples

Content type
application/json
{
  • "dependente_id": 0
}

Tutores

Tudo sobre os tutores

Cadastro de tutor

Este endpoint é para fazer um cadastro de tutor.

Authorizations:
basicAuth
Request Body schema: application/json
cpf
required
string (CPF do tutor.)
nome
required
string (Nome do tutor)

Nome completo do tutor

sobrenome
string (Sobrenome do tutor)
email
required
string (Email do tutor)

Identificador único que permite localizar um determinado tutor através de um determinado email.

celular
required
string
cep
required
string
rua
required
string
numero
required
string
complemento
string
bairro
required
string
cidade
required
string
estado
required
string
sexo
string

Identificação do sexo do tutor:

  • m = Masculino
  • f = Feminino
  • prefere_nao_informar = Não Informado
data_nascimento
required
string

Responses

Request samples

Content type
application/json
{
  • "cpf": 17052897890,
  • "nome": "Vinicius Brito",
  • "sobrenome": "string",
  • "email": "[email protected]",
  • "celular": "string",
  • "cep": "string",
  • "rua": "string",
  • "numero": "string",
  • "complemento": "string",
  • "bairro": "string",
  • "cidade": "string",
  • "estado": "string",
  • "sexo": "string",
  • "data_nascimento": "25/03/1993"
}

Response samples

Content type
application/json
{
  • "id": 45530,
  • "name": "Vinicius Brito",
  • "username": "string",
  • "email": "[email protected]",
  • "status": "string",
  • "page_id": "string",
  • "parceiro": "string",
  • "celular": "string",
  • "cep": "string",
  • "rua": "string",
  • "numero_endereco": "string",
  • "complemento": "string",
  • "bairro_endereco": "string",
  • "cidade": "string",
  • "estado": "string",
  • "sexo": "string",
  • "datanasc": "25/03/1993",
  • "google_userid": "string",
  • "teleinterconsulta_cadastro": "string",
  • "token_user": "string",
  • "teleinterconsulta_senha_configurada": "string",
  • "whatsapp": "string",
  • "email_ofuscado": "string"
}

Busca de tutor

Este endpoint é para trazer dados de um tutor.

Authorizations:
basicAuth
path Parameters
id
required
integer

Id do tutor

Responses

Response samples

Content type
application/json
{
  • "id": 45530,
  • "name": "Vinicius Brito",
  • "username": "string",
  • "email": "[email protected]",
  • "status": "string",
  • "page_id": "string",
  • "parceiro": "string",
  • "celular": "string",
  • "cep": "string",
  • "rua": "string",
  • "numero_endereco": "string",
  • "complemento": "string",
  • "bairro_endereco": "string",
  • "cidade": "string",
  • "estado": "string",
  • "sexo": "string",
  • "datanasc": "25/03/1993",
  • "google_userid": "string",
  • "teleinterconsulta_cadastro": "string",
  • "token_user": "string",
  • "teleinterconsulta_senha_configurada": "string",
  • "whatsapp": "string",
  • "email_ofuscado": "string"
}

Pets

Tudo sobre os pets

Cadastro de Pet

Este endpoint é para fazer um cadastro de Pet.

Authorizations:
basicAuth
Request Body schema: application/json
nome
required
string (Nome do pet)

Nome completo do pet

matricula
required
string (Matricula do pet)
especie
required
string
raca
required
string
porte
required
string
tutor_id
required
integer
sexo
required
string

Identificação do sexo do pet:

  • m = Masculino
  • f = Feminino
data_nascimento
required
string

Responses

Request samples

Content type
application/json
{
  • "nome": "Amora",
  • "matricula": "string",
  • "especie": "string",
  • "raca": "string",
  • "porte": "string",
  • "tutor_id": 0,
  • "sexo": "string",
  • "data_nascimento": "25/03/1993"
}

Response samples

Content type
application/json
{
  • "pet_id": 0
}