Api Key

Autenticação com API Key

Endpoint de Processamento de XML

Base URL: https://api.sieg.com

POST https://api.sieg.com/api/send-xml-external-company

Visão Geral

Este método de autenticação utiliza uma chave única de API enviada via header HTTP personalizado para validar o acesso à plataforma.

Quando utilizar:

  • Integrações simples que requerem apenas uma credencial
  • Aplicações e scripts que precisam acessar a API de forma programática

Tipo de Autenticação: Autenticação baseada em header HTTP personalizado utilizando uma chave única (API Key) para identificação e validação.

Credenciais Necessárias

Headers Obrigatórios

HeaderTipoObrigatórioDescrição
X-API-KeystringSimChave única de API gerada na plataforma para autenticação

Parâmetros Adicionais: Não há parâmetros adicionais necessários. A autenticação é realizada exclusivamente através do header HTTP.

Gerando sua API Key

As chaves de API podem ser geradas e gerenciadas através do painel administrativo:

URL: https://app.sieg.com/unification/integracoes

⚠️ Importante: Guarde sua API Key em local seguro. Por questões de segurança, ela não poderá ser visualizada novamente após a criação.

Exemplo de Requisição

Request HTTP

text

 

cURL - GET

bash

cURL - POST (com body)

bash

Validações Realizadas

O sistema realiza as seguintes validações na ordem apresentada:

  1. Presença do Header Obrigatório: Verifica se o header X-API-Key foi informado na requisição. O header deve estar presente e não pode estar vazio.
  2. Validação da Credencial: Confirma se a API Key corresponde a uma chave válida previamente cadastrada na plataforma. A credencial é verificada no banco de dados através do serviço de autenticação.
  3. Validade Temporal: Verifica se a API Key não está expirada. Cada chave possui uma data de expiração (ExpiresAt) que é validada contra o horário atual (UTC).

Respostas

Sucesso (200 OK)

Quando a autenticação é bem-sucedida, a requisição prossegue normalmente para o endpoint solicitado. Não há uma resposta específica de autenticação, pois o filtro apenas valida e injeta o contexto da API Key.

A resposta dependerá do endpoint acessado.

Erros Possíveis

401 Unauthorized - API Key Não Fornecida

Quando ocorre: Quando o header X-API-Key não foi informado ou está vazio.

json

 

401 Unauthorized - API Key Inválida

Quando ocorre: Quando a API Key fornecida não corresponde a nenhuma chave cadastrada na plataforma.

json

 

401 Unauthorized - API Key Expirada

Quando ocorre: Quando a API Key é válida, mas sua data de expiração já passou.

json