Axuz Developers

POST /api/teams/{teamId}/mail/api-keys/

Emite nova chave (plaintext retornado uma vez)

  • Acesso: Admin da equipe
  • Serviço: https://mail-api.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

Gera plaintext (prefix + 43 chars base62), armazena SHA-256, devolve plaintext SÓ neste response. Se perder, revoga e cria outra.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
namestringsim
scopesarray<string>não
rate_limit_per_minintegernão
allowed_from_addressesarray<string<email>>não

Whitelist de from. Vazio = qualquer from do team.

{
  "name": "string",
  "scopes": [
    "mail:send"
  ],
  "rate_limit_per_min": 60,
  "allowed_from_addresses": [
    "pessoa@example.test"
  ]
}

Respostas

201

Chave criada — key aparece uma única vez

NomeTipoObrigatórioDescrição
idstring<uuid>sim
keystringsim

Plaintext retornado UMA vez. Formato: axz_{live|test}_<43 chars base62>. Grave, não é recuperável.

key_prefixstringsim
namestringsim
scopesarray<string>sim
rate_limit_per_minintegersim
allowed_from_addressesarray<string<email>>não
created_atstring<date-time>sim

400

Payload inválido / name obrigatório

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Não é owner/admin

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X POST 'https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","scopes":["mail:send"],"rate_limit_per_min":60,"allowed_from_addresses":["pessoa@example.test"]}'

Node.js

const res = await fetch("https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "scopes": [
      "mail:send"
    ],
    "rate_limit_per_min": 60,
    "allowed_from_addresses": [
      "pessoa@example.test"
    ]
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "name": "string",
        "scopes": [
            "mail:send",
        ],
        "rate_limit_per_min": 60,
        "allowed_from_addresses": [
            "pessoa@example.test",
        ],
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())