Ogmma Revenue

Eventos

POST/v1/assinaturas/{id}/segredo

Troca o segredo de assinatura

O segredo antigo deixa de valer na hora. Devolvido UMA vez.

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 POST https://api.miydas.com.br/v1/assinaturas/cmf3k2x9a0001aut/segredo \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

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

O segredo novo depois da troca. O anterior para de valer na hora.

Campos de SegredoAssinatura

CampoTipoO que é
idtextoIdentificador 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.
segredotextoSó nesta resposta. Guarde: é com ele que se confere o cabeçalho miydas-assinatura.

Exemplo de retorno

{
  "data": {
    "id": "cmf3k2x9a0003ass",
    "segredo": "whsec_exemplo"
  }
}

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_trocarSegredo

O 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ó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.