Conexões
/v1/credenciais/verificacoesTesta as credenciais de uma conexão
Enfileira o trabalho na operadora e responde 202 com o identificador — acompanhe em GET /v1/execucoes/{id}. NÃO aceita Prefer: wait=N.
- Escopo:
- credencial:verificar
- Resposta:
- 202
Pedido
Corpo (JSON)
| Campo | Tipo | O que é |
|---|---|---|
| registroANS* | texto 4–20 caracteres | Registro ANS da operadora. É por ele que o Revenue resolve conector e credencial. |
| callbackUrl | — | NÃO ENVIAR. O webhook é configurado uma vez, na concessão, e ganha segredo de assinatura. Destino por chamada não seria assinado nem auditável. |
| conexaoId | texto | Qual conexão testar. Sem ele, cai na preferência de canal — o que dá resposta errada quando a operadora tem RPA e webservice configurados. |
* 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 POST https://api.miydas.com.br/v1/credenciais/verificacoes \
-H "Authorization: Bearer $MIYDAS_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"registroANS": "334561"
}'Resposta 202
| data | ExecucaoEnfileirada | O recurso. Os campos estão na tabela abaixo. |
Campos de ExecucaoEnfileirada
| Campo | Tipo | O que é |
|---|---|---|
| execucaoId | texto | Identificador da execução enfileirada. |
| status | texto | Estado do processamento no momento da resposta. |
| operacao | texto | A operação que foi enfileirada, no vocabulário do Miydas. |
| operadora | objeto | A operadora do documento, identificada pelo registro ANS. |
| registroANS | texto | Registro ANS da operadora. |
| consultarEm | texto | Caminho para acompanhar o desfecho desta execução. |
| ressalva | texto | Limite conhecido desta operação, ou null quando não há. Vem SEMPRE, para o integrador não ter de distinguir chave ausente de ausência de ressalva. |
Exemplo de retorno
{
"data": {
"execucaoId": "cmf3k2x9a0001exe",
"status": "PENDENTE",
"operacao": "VALIDATE_CREDS",
"operadora": {
"registroANS": "334561"
},
"consultarEm": "/v1/execucoes/cmf3k2x9a0001exe",
"ressalva": null
}
}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/credenciais_verificacoesO sandbox responde sempre em GET, mesmo para uma operação POST: ele devolve a forma da resposta, não executa nada.
A 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. |
| OPERACAO_NAO_COBERTA | 422 | A operadora não oferece esta operação. details.operacoesDisponiveis lista o que ela oferece. | Não repita: a resposta não muda. |
| CREDENCIAL_AUSENTE | 422 | A empresa não cadastrou a credencial desta operadora. | Cadastre a credencial no Miydas e repita. |
| AMBIENTE_TESTE_INDISPONIVEL | 422 | A chave é de teste (myd_test_…) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção. | Configure a homologação da operadora no Miydas; para autorização e elegibilidade use /v1/autorizacoes e /v1/elegibilidades; o resto, com a chave de produção. |
| LIMITE_EXCEDIDO | 429 | Muitas operações em andamento para esta operadora nesta empresa. | Espere e repita — com a mesma Idempotency-Key, se for escrita. |
Depois de aceita, ainda pode falhar — e aí o erro aparece em processamento.erro, não na resposta do pedido:
OPERADORA_INDISPONIVEL— A operadora não respondeu, ou respondeu fora do padrão. SepodeRepetirfor true, repita depois. Se for false (escrita), consulte antes de repetir — o pedido pode ter chegado.CREDENCIAL_RECUSADA— A operadora recusou a credencial cadastrada. Atualize a credencial no Miydas.CONEXAO_INCOMPLETA— Falta um dado obrigatório na conexão da empresa com a operadora (ex.: nome do contratado). Nada foi enviado à operadora. Complete a conexão no Miydas e repita — a mensagem diz o que falta.PEDIDO_RECUSADO— A operadora recusou o pedido antes de analisar (ex.: código de procedimento que ela não aceita). A mensagem traz o motivo dela. Corrija o pedido conforme o motivo e peça de novo — nada foi autorizado.PEDIDO_INCOMPLETO— Falta um dado que esta operadora exige (ex.: indicação clínica na Bradesco). Nada foi enviado. Complete o pedido e repita.OPERADORA_OCUPADA— O acesso da empresa à operadora estava em uso por outra pessoa no momento. Nada foi enviado. Repita em alguns minutos.DADOS_RECUSADOS— A operadora — ou a validação do Miydas antes do envio — recusou os dados do pedido.messagediz qual dado quando isso se sabe: o conselho do profissional, o registro ANS na credencial da operadora, procedimentos acima do limite, o cadastro do prestador na operadora (a conexão sem o nome do contratado sai como CONEXAO_INCOMPLETA). Recusado antes do envio, nada chegou à operadora epodeRepetiré true; recusado pela operadora numa escrita,podeRepetiré false, como em toda escrita que chegou lá. Corrija o dado apontado — no pedido ou na credencial da operadora no Miydas — e faça um pedido novo: repetir igual dá a mesma recusa. Solicitação de autorização que não chegou à operadora (a mensagem diz) pode ser refeita com o mesmonumeroGuiaPrestador.
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.