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 CLIENT_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.

Cabeçalhos

Header Valor
X-API-Key Sua X-API-KEY
X-Secret-Key Sua X-SECRET-KEY
Content-Type application/json

Corpo da Requisição

Campo Tipo Descrição
client_code string CPF do paciente (somente números)
Bash
curl -X POST https://sdk.mediquo.com/v1/patients/authenticate \
  -H "X-API-Key: sua_api_key" \
  -H "X-Secret-Key: sua_secret_key" \
  -H "Content-Type: application/json" \
  -d '{"client_code": "12345678901"}'

Resposta de Sucesso — 200 OK

JSON
{
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

Validade do Token

O access_token expira em 24 horas. 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 (CPF) access_token (válido 24h) 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