Eventos
GET
/v1/assinaturas/{id}Uma assinatura
- 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 \
-H "Authorization: Bearer $MIYDAS_CHAVE"Resposta 200
| data | Assinatura | O recurso. Os campos estão na tabela abaixo. |
Campos de Assinatura
| 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. |
| url | texto | A URL, com esquema. |
| eventos | lista de texto | Nomes exatos, recurso.* ou * |
| descricao | texto | Para que serve esta assinatura. É o que distingue uma da outra na lista. |
| ativa | booleano | A assinatura está recebendo eventos. |
| criadaEm | texto | Quando o registro nasceu no Miydas, em ISO 8601 com fuso. |
| atualizadaEm | texto | Quando o registro mudou pela última vez no Miydas, em ISO 8601 com fuso. |
Exemplo de retorno
{
"data": {
"id": "cmf3k2x9a0003ass",
"url": "https://produto.exemplo.com.br/webhooks/miydas",
"eventos": [
"autorizacao.*"
],
"descricao": "Avisos de autorização",
"ativa": true,
"criadaEm": "2026-09-27T12:00:00.000Z",
"atualizadaEm": "2026-09-27T12:00:00.000Z"
}
}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/assinaturas_obterA 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 |
|---|---|---|---|
| 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.