Introdução - Sauddy API

A API Sauddy permite que parceiros de distribuição (provedores, operadoras e demais colaboradores) ofereçam a telemedicina Sauddy aos seus clientes diretamente pelos próprios sistemas: cadastrar beneficiários, alterar o status de contratos e consultar contratos existentes.

URL base

Todas as requisições são feitas via HTTPS para:

https://api.sauddy.com.br

Os caminhos dos endpoints começam em /v1, por exemplo https://api.sauddy.com.br/v1/Authorization/Login.

Endpoints disponíveis

Método	Caminho	Para que serve
`POST`	`/v1/Authorization/Login`	Gera o token de acesso a partir das suas credenciais
`POST`	`/v1/TeleMedicina/Adesao`	Cadastra um beneficiário em um plano (adesão)
`POST`	`/v1/TeleMedicina/AlteraStatus`	Ativa, suspende ou cancela um contrato
`POST`	`/v1/TeleMedicina/ConsultaStatus`	Consulta o status de um contrato específico
`GET`	`/v1/TeleMedicina/contratos/:cpf`	Lista todos os contratos de um CPF

Credenciais

Para usar a API você recebe da Sauddy:

companyId: identificador da sua empresa na Sauddy.
apiKey de homologação: para desenvolver e testar a integração.
apiKey de produção: para operar com dados reais.

Guarde suas credenciais com segurança:

A apiKey dá acesso aos contratos da sua empresa. Mantenha-a apenas no servidor (backend) da sua aplicação, nunca em aplicativos móveis, páginas web ou repositórios de código.

Ambientes: homologação e produção

A URL é a mesma para os dois ambientes. O que define o ambiente é a apiKey usada no login:

Ambiente	Como acessar	Comportamento
Homologação	Login com a `apiKey` de homologação	Respostas simuladas com o mesmo formato da produção. Nada é gravado e nenhum beneficiário é cadastrado de verdade.
Produção	Login com a `apiKey` de produção	Operações reais: contratos são criados, alterados e enviados à rede de telemedicina.

Recomendamos concluir e validar toda a integração em homologação antes de trocar para a chave de produção.

Fluxo da integração

Autentique-se

Chame o login com apiKey e companyId e guarde o token retornado.

Faça a adesão do beneficiário

Envie os dados do cliente e o código do plano (codigoOnix) para a adesão. Guarde o numeroCartao retornado: ele identifica o contrato nas próximas operações.

Gerencie o contrato

Use alterar status quando o cliente for suspenso, cancelado ou reativado no seu sistema, e consultar status ou contratos por CPF para conferir a situação.

Convenções

Formato: envie e receba JSON, com o cabeçalho Content-Type: application/json.
Autenticação: exceto o login, todos os endpoints exigem o cabeçalho Authorization: Bearer <token>.
CPF: aceito com ou sem máscara (123.456.789-09 ou 12345678909). A API usa apenas os dígitos.
Código do plano: o campo codigoOnix identifica o plano contratado. Veja a lista de planos.
Datas nas respostas: formato AAAA-MM-DD HH:mm:ss, em UTC.
Campos desconhecidos: a API rejeita campos que não estão documentados (erro 400). Envie somente os campos listados em cada endpoint.

Formato das respostas

Respostas de sucesso seguem o envelope abaixo, em que data traz o resultado da operação:

{
  "data": {},
  "errorMessage": "",
  "success": true
}

Respostas de erro usam o código HTTP correspondente e o formato:

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Token inválido ou expirado.",
  "path": "/v1/TeleMedicina/ConsultaStatus"
}

Sempre verifique o código HTTP da resposta. Veja todos os casos em Erros e limites.

Autenticação