Eventos
GET
/v1/assinaturas/{id}/entregasAs últimas 50 entregas, com o que o destino respondeu
- Escopo:
- webhook:gerenciar
- 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/assinaturas/cmf3k2x9a0001aut/entregas \
-H "Authorization: Bearer $MIYDAS_CHAVE"Resposta 200
| data | lista de Entrega | O recurso. Os campos estão na tabela abaixo. |
Campos de Entrega
| Campo | Tipo | O que é |
|---|---|---|
| id | texto | 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. |
| evento | texto | O nome do evento, no formato recurso.fato. |
| recurso | objeto | Que tipo de recurso este registro descreve. |
| tipo | texto | Que tipo de recurso o evento descreve (ex. autorizacao, lote). |
| id | texto | 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. |
| status | texto um de: PENDENTE, ENTREGUE, FALHOU | Em que ponto o processamento está. |
| tentativas | inteiro | Quantas vezes já tentamos. |
| httpStatus | inteiro | O código HTTP que o seu endpoint devolveu na entrega. |
| erro | texto | O que falhou. null quando não falhou nada. |
| criadaEm | texto | Quando o registro nasceu no Miydas, em ISO 8601 com fuso. |
| entregueEm | texto | Quando a entrega do evento foi aceita pelo seu endpoint, em ISO 8601 com fuso. |
| proximaTentativaEm | texto | Quando sai a próxima tentativa de entrega. null = não há outra. |
Erros
| Código | HTTP | Quando | O que fazer |
|---|---|---|---|
| RECURSO_NAO_ENCONTRADO | 404 | O 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.