Referências
/v1/operadoras/{registroANS}/documentosO que a operadora publica, e se conseguimos ler
A resposta para "o que posso esperar receber desta operadora": que documento ela publica, em que formato e com que periodicidade.
leitura: NAO_IMPLEMENTADO é informação útil e desconfortável: a operadora publica e nós ainda não traduzimos, então o documento chega e para na caixa de entrada como PENDENTE.
- Escopo:
- operadora:ler
- Resposta:
- 200
Pedido
Caminho
| {registroANS}* | 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. |
Exemplo de chamada
curl -X GET https://api.miydas.com.br/v1/operadoras/334561/documentos \
-H "Authorization: Bearer $MIYDAS_CHAVE"Resposta 200
| data | DocumentosDaOperadora | O recurso. Os campos estão na tabela abaixo. |
O que a operadora publica, e se conseguimos ler.
Campos de DocumentosDaOperadora
| Campo | Tipo | O que é |
|---|---|---|
| operadora | objeto | A operadora do documento, identificada pelo registro ANS. |
| 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. |
| nome | texto | Razão social da operadora como a ANS a publica. Informativo — a chave é o registro. |
| documentos | lista de objetos | O que esta operadora publica — e, em cada um, se já sabemos traduzir. |
| nome | texto | Como a operadora chama o documento no portal dela. |
| tipoDocumento | texto | Para que tipo nosso ele mapeia (ex. DEMONSTRATIVO_PAGAMENTO). |
| formato | texto | Em que formato o dado chegou. |
| periodicidade | texto | De quanto em quanto tempo ela publica, quando há regra (ex. mensal, quinzenal). |
| leitura | texto | NAO_IMPLEMENTADO = a operadora publica e ainda não traduzimos: o documento chega e para na caixa de entrada como PENDENTE. |
Exemplo de retorno
{
"data": {
"operadora": {
"registroANS": "334561",
"nome": "Unimed Blumenau"
},
"documentos": [
{
"nome": "Demonstrativo de pagamento (XML TISS)",
"tipoDocumento": "DEMONSTRATIVO_PAGAMENTO",
"formato": "XML_TISS_FORMAT",
"periodicidade": "MENSAL",
"leitura": "PRODUCAO"
}
]
}
}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/operadoras_documentosA 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
| Código | HTTP | Quando | O que fazer |
|---|---|---|---|
| OPERADORA_NAO_ENCONTRADA | 404 | A empresa não tem essa operadora (registro ANS) cadastrada. | Veja as operadoras em GET /v1/operadoras. |
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.