API
Versionamento
O que pode mudar na API v1 sem aviso, o que é mudança incompatível e quanto tempo você tem para se adaptar.
A versão fica no caminho: https://api.rivoo.gg/v1/.... Dentro da v1, sua integração continua funcionando: a Rivoo só faz mudanças compatíveis sem aviso.
Mudanças compatíveis
Podem chegar a qualquer momento, sem aviso prévio. Escreva sua integração para aceitá-las:
- Endpoint novo, ou parâmetro opcional novo num endpoint existente.
- Campo novo numa resposta ou no
data.objectde um webhook. - Evento de webhook novo. Um webhook sem eventos marcados recebe todos, inclusive os novos: ignore os tipos que você não trata.
- Valor novo num enum (
status,source,method…). Trate valores desconhecidos sem quebrar. - Código de erro novo. Use o status HTTP como reserva quando não conhecer o
code. - Mudança no texto de
title,descriptionou mensagens. Dependa só decode. - Mudança no formato dos ids depois do prefixo (
ord_,prod_…). Guarde o id inteiro como texto e não o interprete.
Mudanças incompatíveis
Exigem aviso prévio:
- Remover ou renomear um endpoint, campo, parâmetro ou evento.
- Mudar o tipo de um campo, ou tornar obrigatório algo que era opcional.
- Mudar o significado de um valor existente.
- Mudar a assinatura dos webhooks ou as regras de autenticação.
Prazo
Toda mudança incompatível é anunciada no Changelog com pelo menos 6 meses de antecedência, com a data de saída e o que usar no lugar. Durante o prazo, o comportamento antigo e o novo funcionam lado a lado.
A exceção é correção de segurança: se um comportamento expõe dados ou contas, ele pode mudar antes, e o aviso sai no Changelog no mesmo dia.
Depreciado agora
| O quê | Use no lugar | Sai em |
|---|---|---|
Campos *Cents dos webhooks (totalCents, amountCents, refundedCents…) | O objeto de mesmo nome sem Cents (total, amount, refunded), { "amount": 2990, "currency": "BRL" } | 01/05/2027 |