Visão geral da API

A API Rivox é REST, aceita e devolve JSON e usa códigos de estado HTTP convencionais. Todos os recursos partilham o mesmo envelope de resposta.

URL base

https://api.rivox.co.mz/v1

Envelope de resposta

// Sucesso
{
  "data": { "object": "account", "id": "acct_..." },
  "meta": { "request_id": "req_..." }
}

// Erro
{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "This API key is not active."
  },
  "meta": { "request_id": "req_..." }
}

Convenções

• Cada resposta inclui o cabeçalho X-Request-Id, igual a meta.request_id.
• Respostas nunca são colocadas em cache (Cache-Control: no-store).
• Listas devolvem { "object": "list", "data": [...] }.
• Identificadores públicos são estáveis e prefixados por tipo de recurso.

Endpoints disponíveis