Pular para conteúdo
Postman

SDK MediQuo

O SDK MediQuo permite incorporar funcionalidades de telemedicina diretamente no frontend de sua aplicação — chat, vídeo e voz com profissionais de saúde.

Importante: Cadastro de Pacientes

O cadastro de pacientes deve ser feito através da API ID MediQuo (nosso portal de gestão de licenças). O SDK é exclusivamente para integração frontend após o paciente já estar cadastrado.

Consulte: Pacientes - ID MediQuo

Plataforma Versão Mínima Documentação
Widget Web Navegadores modernos Widget Web
Android API 29+ Android SDK
iOS iOS 17+ iOS SDK

Como Funciona

O SDK identifica cada paciente pelo CPF, que é o parâmetro code usado para autenticar o acesso à plataforma de telemedicina da MediQuo.

A integração tem dois momentos distintos:

Cadastro (uma única vez por paciente) O paciente é registrado via API ID MediQuo. Isso sincroniza o CPF com a plataforma de telemedicina. Ver Pacientes.

Sessão (a cada vez que o usuário abre o SDK) Seu sistema chama o endpoint de autenticação da MediQuo com as credenciais do parceiro e o CPF do paciente — recebe um access_token válido por 24h, que é usado para inicializar o SDK no frontend.


Credenciais

Para autenticar na API do SDK, você precisa da x-api-key e x-secret-key. Solicite à MediQuo.

Segurança

Nunca exponha x-api-key e x-secret-key no código do frontend. Essas chamadas devem ser feitas server-side.


Autenticação do Paciente

URL Base: https://sdk.mediquo.com/v1

POST /patients/authenticate

Autentica um paciente e retorna o token de acesso para inicializar o SDK.

Exclusivo para Widget Web

Este endpoint aplica-se apenas à integração via Widget Web. Para Android e iOS, a autenticação é feita diretamente pelo SDK nativo.

Cabeçalhos

Header Valor
x-api-key Sua x-api-key
x-secret-key Sua x-secret-key

Credenciais

As chaves x-api-key e x-secret-key são fornecidas pela MediQuo. Entre em contato com o suporte para obtê-las.

Parâmetros de Query

Parâmetro Tipo Obrigatório Descrição
code string sim CPF do paciente (somente números)
Bash
curl -X POST "https://sdk.mediquo.com/v1/patients/authenticate?code=12345678901" \
  -H "x-api-key: sua_api_key" \
  -H "x-secret-key: sua_secret_key"

Resposta de Sucesso — 200 OK

JSON
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "token_type": "Bearer"
}

Validade do Token

Não armazene o token entre sessões — gere um novo a cada vez que o paciente for usar o SDK.


Fluxo Completo

Fluxo de Integração SDK MediQuo PASSO 1 — CADASTRO (uma única vez) SEU BACKEND API ID MEDIQUO POST /patients (CPF + dados) paciente registrado PASSO 2 — AUTENTICAÇÃO (a cada sessão) SEU SISTEMA SDK API sdk.mediquo.com POST /patients/authenticate (?code=CPF) access_token PASSO 3 — INICIALIZAÇÃO DO SDK FRONTEND SDK MEDIQUO (Widget / Android / iOS) inicializa SDK com apiKey + access_token SDK pronto para uso


Próximos Passos