Começar com a API

Antes de começar

Precisa de uma conta na MozOut com um serviço ou um domínio activo. A API responde em:

https://api.mozout.com/v1

A API usa JSON sobre HTTPS, e os nomes dos campos estão em inglês.

Confirmar que a API responde

Esta operação não precisa de chave, por isso é o melhor primeiro teste:

curl "https://api.mozout.com/v1/ping" \
  -H "Accept-Language: pt"

<?php
$ch = curl_init('https://api.mozout.com/v1/ping');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

import os
import requests

headers = {
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/ping", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

const response = await fetch("https://api.mozout.com/v1/ping", {
  headers: {
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Resposta:

{
  "data": {
    "status": "ok",
    "version": "v1",
    "time": "2026-11-04T21:30:00+02:00"
  },
  "meta": {}
}

O exemplo em Python usa a biblioteca requests, e o de JavaScript corre no Node.js 18 ou mais recente.

Criar uma chave

1. Entre no My MozOut e abra a página API.
2. Dê um nome à chave e escolha o tipo. Para começar, escolha o modo Sandbox (sandbox_).
3. Escolha as permissões e a validade.
4. Confirme com a sua senha e com o código de 6 dígitos que recebe por e-mail.
5. Copie a chave. Só é mostrada desta vez.

Os pormenores estão em Autenticação e chaves.

Guardar a chave

Guarde a chave numa variável de ambiente, fora do código:

export RLX_API_KEY="sandbox_..."

Os exemplos desta documentação lêem a chave de RLX_API_KEY.

Fazer o primeiro pedido com chave

Esta operação mostra as permissões, a validade e os limites da chave que fez o pedido:

curl "https://api.mozout.com/v1/token" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

<?php
$ch = curl_init('https://api.mozout.com/v1/token');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/token", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

const response = await fetch("https://api.mozout.com/v1/token", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Resposta:

{
  "data": {
    "id": 12,
    "name": "Example key",
    "type": "sandbox",
    "mode": "sandbox",
    "writes_simulated": true,
    "suffix": "AbCd",
    "permissions": [
      "dns:read"
    ],
    "allowed_ips": [
      "198.51.100.0/24"
    ],
    "expires_at": "2027-02-02T10:00:00+02:00",
    "created_at": "2026-11-04T10:00:00+02:00",
    "last_used_at": "2026-11-04T21:30:00+02:00",
    "rate_limit": {
      "limit": 90,
      "remaining": 89,
      "reset": 1793820660,
      "window_seconds": 60
    },
    "spending": {
      "limit": 0,
      "spent": 0,
      "currency": "USD",
      "window_days": 30
    }
  },
  "meta": {}
}

Formato das respostas

Uma resposta com sucesso traz sempre data e meta, excepto em GET /v1/openapi.json, que devolve o documento sem este envelope:

{
  "data": {},
  "meta": {}
}

Uma resposta com erro traz error, com um código estável. Veja Erros.

Todas as respostas trazem o cabeçalho X-Correlation-ID. Indique-o ao suporte se comunicar um problema.

Língua das mensagens

Envie Accept-Language: pt ou Accept-Language: en para escolher a língua das mensagens de erro. Sem este cabeçalho, as mensagens vêm em inglês. O campo code nunca muda com a língua.

Operações longas

As operações que demoram respondem 202 com um action_id. Em vez de repetir o pedido, acompanhe o resultado com GET /v1/actions/{id}. Os estados são queued, running, done e failed.

Próximos passos

• Permissões: dê a cada chave só aquilo de que ela precisa.
• Limites: quantos pedidos pode fazer por minuto.
• Sandbox e Produção: o que as chaves sandbox_ e prod_ fazem.
• Referência: todas as operações, com filtro, a ligar à página de cada área.