ydoc
Console
API v1.0

ydoc Developer API

Integre sua aplicacao com a plataforma ydoc. Acesse pacientes, agendamentos, prontuarios e mais via REST API.

Projetada para seguranca e escalabilidade

Autenticacao segura

Tokens de API com SHA-256, escopos granulares e aprovacao manual pelo administrador.

Rate limiting

Limites configuraveis por chave. Protecao contra abuso com sliding window de 1 minuto.

REST JSON

API RESTful com respostas JSON padronizadas. Swagger UI disponivel para testes interativos.

Multi-tenant

Cada chave esta vinculada a um tenant especifico. Isolamento total de dados entre clinicas.

Autenticacao

Todas as requisicoes autenticadas via API key devem incluir o header X-API-Key com o token recebido na aprovacao.

1

Solicite acesso

Preencha o formulario com seu caso de uso

2

Aprovacao

Nosso time analisa e aprova o acesso com scopes especificos

3

Integre

Use o token no header X-API-Key para autenticar suas requisicoes

Exemplo de requisicao

curl -X GET "https://backend-production-3f693.up.railway.app/patients" \
  -H "X-API-Key: ydoc_ak_seu_token_aqui" \
  -H "Content-Type: application/json"

Resposta

{
  "patients": [
    {
      "id": "abc-123",
      "firstName": "Maria",
      "lastName": "Silva",
      "email": "[email protected]",
      "phone": "(11) 99999-0000"
    }
  ]
}

Escopos disponiveis

Cada token recebe escopos especificos que limitam o acesso aos recursos

read:patientsListar e visualizar pacientes
write:patientsCriar e editar pacientes
read:appointmentsListar e visualizar agendamentos
write:appointmentsCriar e gerenciar agendamentos
read:recordsAcessar prontuarios medicos
write:recordsCriar prontuarios
read:financeVisualizar transacoes financeiras
read:proceduresListar procedimentos
read:availabilityConsultar horarios disponiveis

Rate limiting

Cada API key tem um limite configuravel de requisicoes por minuto. O padrao e 100 req/min. Ao exceder, a API retorna status 429.

100

req/min padrao

429

status quando excedido

60s

janela de sliding window

Pronto para integrar?

Solicite acesso e comece a construir sua integracao com o ydoc