Referências
/v1/referencias/operadoras-ansOperadoras registradas na ANS — ache o registroANS pelo CNPJ
Toda operação desta API pede registroANS, e quem integra costuma ter o CNPJ. Esta rota faz a ponte: busca por CNPJ (com ou sem máscara), por nome ou pelo próprio registro.
São 1.110 operadoras ativas. Estar aqui não significa que o Miydas a atende — isso é GET /v1/operadoras.
- Escopo:
- operadora:ler
- Resposta:
- 200
Pedido
Parâmetros de query
| Campo | Tipo | O que é |
|---|---|---|
| busca | texto 2–120 caracteres | Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa. |
| registroAns | texto 1–20 caracteres | Registro da operadora na ANS, seis dígitos, como consta no cadastro público. |
| cnpj | texto 11–18 caracteres | CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem. |
| uf | texto 2–2 caracteres | Sigla da unidade federativa, duas letras (ex. SC). |
| limite | inteiro 1–100 · padrão 25 | Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo. |
| deslocamento | inteiro padrão 0 | Quantos registros pular, para a página seguinte. Use com paginacao.total da resposta; paginacao.temMais diz se vale pedir mais. |
* obrigatório. Campo desconhecido é recusado, não ignorado: a API responde VALIDATION_ERROR em vez de descartar em silêncio.
Exemplo de chamada
curl -X GET https://api.miydas.com.br/v1/referencias/operadoras-ans \
-H "Authorization: Bearer $MIYDAS_CHAVE"Resposta 200
| data | lista de OperadoraAns | O recurso. Os campos estão na tabela abaixo. |
| paginacao | Paginacao | Onde esta página está no total. Vem fora de data. |
Operadora registrada na ANS. É aqui que se acha o registroANS a partir do CNPJ ou do nome.
Campos de OperadoraAns
| Campo | Tipo | O que é |
|---|---|---|
| registroANS | texto | Registro da operadora na ANS, seis dígitos (ex. 334561). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora. |
| cnpj | texto | CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem. |
| razaoSocial | texto | Razão social, como consta no cadastro público. |
| nomeFantasia | texto | Nome fantasia, quando o cadastro informa. |
| modalidade | texto | A natureza da operadora na classificação da ANS (ex. cooperativa médica, medicina de grupo, seguradora). |
| cidade | texto | Município, por extenso. |
| uf | texto | Sigla da unidade federativa, duas letras (ex. SC). |
| registradaEm | texto | Quando o Miydas registrou o fato, em ISO 8601 com fuso. Não é quando ele aconteceu na operadora. |
Exemplo de retorno
{
"data": [
{
"registroANS": "334561",
"cnpj": "82098153000173",
"razaoSocial": "UNIMED BLUMENAU COOPERATIVA DE TRABALHO MEDICO",
"nomeFantasia": "UNIMED BLUMENAU",
"modalidade": "COOPERATIVA_MEDICA",
"cidade": "Blumenau",
"uf": "SC",
"registradaEm": "1999-05-13"
}
],
"paginacao": {
"total": 1,
"limite": 20,
"deslocamento": 0,
"temMais": false
}
}Experimente sem chave
O sandbox devolve este mesmo corpo, sem autenticação e sem tocar na base de ninguém.
curl https://api.miydas.com.br/v1/sandbox/referencias_operadoras_ansA chave de teste myd_test_… é outra coisa: ela opera na homologação da operadora e serve para escrever. Para ver o formato antes de ter credencial, convênio e varredura, é este sandbox.
Erros
Esta rota não tem erro próprio: só os comuns a qualquer chamada com chave — chave ausente ou inválida, escopo insuficiente, parâmetro recusado e erro interno.
Toda falha tem o mesmo formato: { "error": "CODIGO", "message": "…", "details": { … } }. error é estável e serve para lógica; message é para gente e pode mudar. Erros comuns a toda rota com chave (lista completa) não se repetem aqui.