API Reference

Grava um evento (ou um lote de até 100) da trilha de auditoria do seu app

Mande o evento na hora do fato. Com o cabeçalho Idempotency-Key (até 255), repetir a chamada devolve os mesmos ids; a mesma chave com outro corpo é 409. Sem a chave, o evento idêntico é gravado uma vez. A trilha é só de acréscimo: nada se edita nem se apaga antes da retenção. Exige uma chave secreta criada COM o escopo audit_logs:write (chaves sem restrição não o têm).

curl --request POST \
  --url https://api.unifokal.com/v1/audit-logs/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>",
  "occurred_at": "<string>",
  "actor": {
    "type": "<string>",
    "id": "<string>",
    "name": "<string>",
    "metadata": {}
  },
  "targets": [
    {
      "type": "<string>",
      "id": "<string>",
      "name": "<string>",
      "metadata": {}
    }
  ],
  "organization_id": "<string>",
  "context": {
    "location": "<string>",
    "user_agent": "<string>"
  },
  "metadata": {},
  "version": 500
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    action: '<string>',
    occurred_at: '<string>',
    actor: {type: '<string>', id: '<string>', name: '<string>', metadata: {}},
    targets: [{type: '<string>', id: '<string>', name: '<string>', metadata: {}}],
    organization_id: '<string>',
    context: {location: '<string>', user_agent: '<string>'},
    metadata: {},
    version: 500
  })
};

fetch('https://api.unifokal.com/v1/audit-logs/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.unifokal.com/v1/audit-logs/events"

payload = {
    "action": "<string>",
    "occurred_at": "<string>",
    "actor": {
        "type": "<string>",
        "id": "<string>",
        "name": "<string>",
        "metadata": {}
    },
    "targets": [
        {
            "type": "<string>",
            "id": "<string>",
            "name": "<string>",
            "metadata": {}
        }
    ],
    "organization_id": "<string>",
    "context": {
        "location": "<string>",
        "user_agent": "<string>"
    },
    "metadata": {},
    "version": 500
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": [
    {
      "id": "<string>",
      "replayed": true
    }
  ]
}

{
  "error": "invalid_json",
  "message": "<string>"
}

{
  "error": "invalid_api_key",
  "message": "<string>"
}

{
  "error": "insufficient_balance",
  "message": "<string>"
}

{
  "error": "credential_type_not_allowed",
  "message": "<string>"
}

{
  "error": "organization_not_found",
  "message": "<string>"
}

{
  "error": "idempotency_key_reused",
  "message": "<string>"
}

{
  "error": "payload_too_large",
  "message": "<string>"
}

{
  "error": "audit_batch_size",
  "message": "<string>"
}

{
  "error": "rate_limited",
  "message": "<string>"
}

Autorizações

Authorization

string

header

obrigatório

Chave secreta (unifokal_live_ em produção, unifokal_test_ no sandbox: 64 hex mais CRC-32) no Authorization: Bearer. Só no seu servidor: nunca no browser ou app (o widget monta apenas com o id vs_ da sessão). Não existe chave publishable.

Cabeçalhos

Idempotency-Key

string

Maximum string length: 255

Corpo

application/json

Option 1
Option 2

Um evento do seu app. organization_id é a empresa (aorg_) do seu cliente, ou null para um evento da sua conta. occurred_at até 5 minutos no futuro e dentro da retenção. metadata só com valores simples (texto, número, booleano), até 50 chaves e 4 KiB.

action

string

obrigatório

Maximum string length: 100

Pattern: ^[a-z][a-z0-9_]*(\.[a-z0-9_]+)+$

occurred_at

string

obrigatório

actor

object

obrigatório

Show child attributes

targets

object[]

obrigatório

Required array length: 1 - 50 elements

Show child attributes

organization_id

string

Pattern: ^aorg_[0-9A-HJKMNP-TV-Z]{26}$

context

object

Show child attributes

metadata

object

version

integer

Intervalo obrigatório: 1 <= x <= 1000

Resposta

Os ids, na ordem do lote.

data

object[]

obrigatório

Show child attributes

Grava um evento (ou um lote de até 100) da trilha de auditoria do seu app

curl --request POST \
  --url https://api.unifokal.com/v1/audit-logs/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>",
  "occurred_at": "<string>",
  "actor": {
    "type": "<string>",
    "id": "<string>",
    "name": "<string>",
    "metadata": {}
  },
  "targets": [
    {
      "type": "<string>",
      "id": "<string>",
      "name": "<string>",
      "metadata": {}
    }
  ],
  "organization_id": "<string>",
  "context": {
    "location": "<string>",
    "user_agent": "<string>"
  },
  "metadata": {},
  "version": 500
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    action: '<string>',
    occurred_at: '<string>',
    actor: {type: '<string>', id: '<string>', name: '<string>', metadata: {}},
    targets: [{type: '<string>', id: '<string>', name: '<string>', metadata: {}}],
    organization_id: '<string>',
    context: {location: '<string>', user_agent: '<string>'},
    metadata: {},
    version: 500
  })
};

fetch('https://api.unifokal.com/v1/audit-logs/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.unifokal.com/v1/audit-logs/events"

payload = {
    "action": "<string>",
    "occurred_at": "<string>",
    "actor": {
        "type": "<string>",
        "id": "<string>",
        "name": "<string>",
        "metadata": {}
    },
    "targets": [
        {
            "type": "<string>",
            "id": "<string>",
            "name": "<string>",
            "metadata": {}
        }
    ],
    "organization_id": "<string>",
    "context": {
        "location": "<string>",
        "user_agent": "<string>"
    },
    "metadata": {},
    "version": 500
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": [
    {
      "id": "<string>",
      "replayed": true
    }
  ]
}

{
  "error": "invalid_json",
  "message": "<string>"
}

{
  "error": "invalid_api_key",
  "message": "<string>"
}

{
  "error": "insufficient_balance",
  "message": "<string>"
}

{
  "error": "credential_type_not_allowed",
  "message": "<string>"
}

{
  "error": "organization_not_found",
  "message": "<string>"
}

{
  "error": "idempotency_key_reused",
  "message": "<string>"
}

{
  "error": "payload_too_large",
  "message": "<string>"
}

{
  "error": "audit_batch_size",
  "message": "<string>"
}

{
  "error": "rate_limited",
  "message": "<string>"
}