Ogmma Revenue

Recebimento

GET/v1/execucoes/{id}/passos

Onde o robô esteve e onde parou

GET /v1/execucoes/{id} devolve o desfecho; esta rota devolve o caminho. Quando uma execução falha, é aqui que se vê se nem chegou a logar, se logou e não achou o documento, ou se achou e o download caiu. Execução retentada traz os passos das duas tentativas, e cada passo diz de qual tentativa é. details e screenshotUrl NÃO saem: o primeiro é despejo do conector e mudaria a cada ajuste de leiaute; o segundo aponta para uma imagem que pode conter dado de paciente na tela do portal.

Escopo:
execucao:ler
Resposta:
200

Pedido

Caminho

{id}*Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato.

Exemplo de chamada

curl -X GET https://api.miydas.com.br/v1/execucoes/cmf3k2x9a0001aut/passos \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

dataPassosDaExecucaoO recurso. Os campos estão na tabela abaixo.

Onde o robô esteve e onde parou. Quando uma execução falha, é aqui que se vê se nem chegou a logar, se logou e não achou o documento, ou se achou e o download caiu.

Campos de PassosDaExecucao

CampoTipoO que é
execucaoIdtextoA execução que produziu este registro, pelo identificador do Miydas.
tentativasinteiroQuantas execuções a cadeia tem: a raiz mais as retentativas.
passoslista de objetosA trilha, em ordem. É aqui que se vê se o robô nem chegou a logar, se logou e não achou o documento, ou se achou e o download caiu.
tentativainteiroQual tentativa produziu este passo.
numerointeiroA ordem do passo dentro da tentativa, a partir de 1.
nometextoO que o passo faz, em uma linha (ex. login, buscar documento, baixar).
tipotextoA categoria do passo — navegação, requisição, extração.
situacaotexto
um de: PENDING, RUNNING, SUCCESS, FAILED, SKIPPED
Como este passo terminou. O primeiro FAILED da lista é onde a execução realmente parou.
iniciadoEmtextoQuando o processamento começou, em ISO 8601 com fuso.
concluidoEmtextoQuando o processamento terminou, em ISO 8601 com fuso. null = ainda corre.
duracaoMsinteiroQuanto durou, em milissegundos.
errotextoO que falhou. null quando não falhou nada.

Exemplo de retorno

{
  "data": {
    "execucaoId": "cmf3k2x9a0001exe",
    "tentativas": 1,
    "passos": [
      {
        "tentativa": 1,
        "numero": 1,
        "nome": "login",
        "tipo": "AUTH",
        "situacao": "SUCCESS",
        "iniciadoEm": "2026-10-24T20:57:01.000Z",
        "concluidoEm": "2026-10-24T20:57:09.000Z",
        "duracaoMs": 8140,
        "erro": null
      },
      {
        "tentativa": 1,
        "numero": 2,
        "nome": "buscar demonstrativos",
        "tipo": "FETCH",
        "situacao": "FAILED",
        "iniciadoEm": "2026-10-24T20:57:09.000Z",
        "concluidoEm": "2026-10-24T20:57:24.000Z",
        "duracaoMs": 15002,
        "erro": "Nenhum relatório consolidado emitido nesta conta"
      }
    ]
  }
}

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/execucoes_passos

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ódigoHTTPQuandoO que fazer
RECURSO_NAO_ENCONTRADO404O id não existe — ou é de outra empresa, o que a API não distingue de propósito. Também a rota inexistente na v1.Confira o id.

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.