Conta e segurança

Actualizado em 05/11/20261 min de leitura

A API já lê os dados da conta. As alterações continuam no My MozOut, e as chaves da API gerem-se na página API.

O que precisa

Uma chave com a permissão account:read. Veja Permissões.

Os dados da conta

GET /v1/account devolve o nome, a empresa, o e-mail, a morada, a moeda e o estado da conta. Nunca devolve senhas nem dados de cartão.

curl

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

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/account');
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;

Python

import os
import requests

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

JavaScript

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

Contactos e utilizadores

GET /v1/account/contacts: os contactos registados na conta.
GET /v1/account/users: as pessoas com acesso à conta. Primeiro vem o dono, com owner a true.

Estas listas vêm em páginas.

O que está previsto

Alterar os dados da conta e os contactos.
Ver o registo de segurança e gerir as chaves SSH.

Uma chave nunca pode criar outra chave, nem mudar a senha ou o e-mail da conta.

Operações

3 operações nesta área. Clique numa operação para ver os parâmetros, os exemplos e as respostas, ou para a experimentar no Playground, sem sair da página.

GET

Ver a conta

/v1/account

GEThttps://api.mozout.com/v1/account

Precisa de account:read. Nunca devolve senhas nem dados de cartão.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: account:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

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

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/account');
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;

Python

import os
import requests

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

JavaScript

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

Respostas

200

Ver a conta.

{
  "data": {
    "id": 35,
    "first_name": "Ana",
    "last_name": "Silva",
    "company": "Exemplo, Lda",
    "email": "[email protected]",
    "phone": "+258.841234567",
    "tax_id": "",
    "address": {
      "line1": "Av. 25 de Setembro, 100",
      "line2": "",
      "city": "Maputo",
      "state": "Maputo",
      "postcode": "1100",
      "country": "MZ"
    },
    "currency": "USD",
    "language": "portuguese",
    "status": "active",
    "email_verified": true,
    "created_at": "2026-01-15"
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar os contactos

/v1/account/contacts

GEThttps://api.mozout.com/v1/account/contacts

Precisa de account:read. Os contactos registados na conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: account:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`page`	consulta	integer	não	O número da página. A primeira é a 1.
`per_page`	consulta	integer	não	Resultados por página, de 1 a 100. Por omissão, 10.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

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

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/account/contacts');
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;

Python

import os
import requests

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

JavaScript

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

Respostas

200

Listar os contactos.

{
  "data": [
    {
      "id": 7,
      "first_name": "Rui",
      "last_name": "Costa",
      "company": "",
      "email": "[email protected]",
      "phone": "+258.821234567",
      "address": {
        "line1": "Av. 25 de Setembro, 100",
        "line2": "",
        "city": "Maputo",
        "state": "Maputo",
        "postcode": "1100",
        "country": "MZ"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar os utilizadores

/v1/account/users

GEThttps://api.mozout.com/v1/account/users

Precisa de account:read. As pessoas com acesso à conta. Primeiro vem o dono.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: account:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`page`	consulta	integer	não	O número da página. A primeira é a 1.
`per_page`	consulta	integer	não	Resultados por página, de 1 a 100. Por omissão, 10.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

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

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/account/users');
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;

Python

import os
import requests

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

JavaScript

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

Respostas

200

Listar os utilizadores.

{
  "data": [
    {
      "id": 35,
      "first_name": "Ana",
      "last_name": "Silva",
      "email": "[email protected]",
      "owner": true,
      "two_factor_enabled": false,
      "permissions": [],
      "last_login_at": "2026-11-04T09:30:00+02:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.