Revogar API Key

Metodo

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

Conceituacao

Revoga imediatamente uma API key existente. Apos a revogacao, todas as requisicoes feitas com essa chave retornarao o erro 401 - INVALID_API_KEY.

Esta acao e irreversivel. Uma vez revogada, a chave nao pode ser reativada. Caso precise de uma nova chave, utilize o endpoint de criacao.

Quando revogar uma chave

• A chave foi comprometida ou exposta publicamente.
• A integracao que utilizava a chave foi desativada.
• Voce esta rotacionando as chaves como boa pratica de seguranca.
• Um colaborador que tinha acesso a chave deixou a organizacao.

Atributos

Header

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

Path Parameters

Atributo	Tipo	Obrigatorio	Descricao
id	string	Sim	ID da API key a ser revogada

Request

cURL

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

Node.js

const axios = require('axios');

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

console.log(response.data);

Python

import requests

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

print(response.json())

Response

200 - API key revogada com sucesso

{
  "success": true,
  "data": {
    "id": "6650a1b2c3d4e5f6a7b8c9d0",
    "name": "Integracao CRM",
    "active": false,
    "revokedAt": "2024-01-20T15:00:00.000Z"
  }
}

401 - Nao autorizado

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

404 - API key nao encontrada

{
  "message": "API key nao encontrada.",
  "code": "INVALID_API_KEY"
}

429 - Rate limit excedido

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

Importante

A revogacao e imediata e irreversivel. Certifique-se de que nenhuma integracao ativa depende desta chave antes de revoga-la. Caso esteja rotacionando chaves, crie a nova chave e atualize suas integracoes antes de revogar a antiga.