Listar API Keys

Metodo

GET https://oapi.ogmma.com.br/v1/api-keys

Conceituacao

Retorna a lista de todas as API keys da sua instituicao. Por seguranca, o valor completo da chave nunca e retornado apos a criacao. Apenas o prefixo (primeiros 8 caracteres) e exibido para identificacao.

Este endpoint permite acompanhar quais chaves estao ativas, suas permissoes, limites e data de ultimo uso.

Atributos

Header

Atributo	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticacao da API

Request

cURL

curl -X GET "https://oapi.ogmma.com.br/v1/api-keys" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://oapi.ogmma.com.br/v1/api-keys',
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.get(
    'https://oapi.ogmma.com.br/v1/api-keys',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

Response

200 - Sucesso

{
  "success": true,
  "data": [
    {
      "id": "6650a1b2c3d4e5f6a7b8c9d0",
      "name": "Integracao CRM",
      "prefix": "oapi_sk_",
      "permissions": [
        "messages.send",
        "messages.read",
        "conversations.read",
        "contacts.read",
        "contacts.write"
      ],
      "rateLimit": 120,
      "active": true,
      "expiresAt": "2025-12-31T23:59:59.000Z",
      "lastUsedAt": "2024-01-20T14:25:00.000Z",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "6650a1b2c3d4e5f6a7b8c9d1",
      "name": "Webhook Notificacoes",
      "prefix": "oapi_sk_",
      "permissions": [
        "webhooks.read",
        "webhooks.write"
      ],
      "rateLimit": 60,
      "active": true,
      "expiresAt": null,
      "lastUsedAt": "2024-01-19T09:10:00.000Z",
      "createdAt": "2024-01-16T08:00:00.000Z"
    },
    {
      "id": "6650a1b2c3d4e5f6a7b8c9d2",
      "name": "Teste Desenvolvimento",
      "prefix": "oapi_sk_",
      "permissions": [
        "sandbox.write",
        "messages.send",
        "messages.read"
      ],
      "rateLimit": 60,
      "active": false,
      "expiresAt": "2024-01-10T23:59:59.000Z",
      "lastUsedAt": "2024-01-09T16:45:00.000Z",
      "createdAt": "2024-01-05T12:00:00.000Z"
    }
  ]
}

Observacao

O campo prefix exibe apenas os primeiros 8 caracteres da chave. O valor completo da chave nunca e retornado apos a criacao. Chaves com active: false foram revogadas ou expiraram.

401 - Nao autorizado

{
  "message": "Token de autenticacao invalido ou ausente.",
  "code": "AUTHENTICATION_REQUIRED"
}

429 - Rate limit excedido

{
  "message": "Limite de requisicoes excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}