Introdução à API

https://api.triglit.com/v1/gateway

​

Características

• ✅ RESTful: Segue padrões REST
• ✅ Versionada: Versão atual: v1
• ✅ Autenticada: Via chaves de API
• ✅ Documentada: OpenAPI 3.0
• ✅ Idempotente: Quando aplicável
• ✅ Observável: Logs e métricas completas

​

Base URL

https://api.triglit.com/v1/gateway

​

Autenticação

X-API-Key: pk_sua_chave_aqui

​

Formatos

​

Request

• Content-Type: application/json
• Accept: application/json

​

Response

• Content-Type: application/json
• Encoding: UTF-8

​

Versionamento

/v1/gateway/workflows  # Versão 1
/v2/gateway/workflows  # Versão 2 (futuro)

• Versões antigas são mantidas por pelo menos 12 meses
• Breaking changes apenas em novas versões
• Deprecation warnings com 6 meses de antecedência

​

Rate Limiting

​

Chave Pública (pk_)

• Limite: 100 requisições/minuto
• Burst: 20 requisições simultâneas

​

Chave Secreta (sk_)

• Limite: 1000 requisições/minuto
• Burst: 100 requisições simultâneas

​

Headers de Rate Limit

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

​

Paginação

​

Query Parameters

• limit: Número de itens por página (padrão: 20, máximo: 100)
• offset: Número de itens para pular (padrão: 0)
• page: Número da página (0-indexed, padrão: 0)

​

Response

{
  "items": [...],
  "total": 150,
  "limit": 20,
  "offset": 0,
  "hasMore": true
}

​

Ordenação

GET /workflows?sortBy=createdAt&sortOrder=desc

• sortBy: Campo para ordenar
• sortOrder: asc ou desc

​

Filtros

GET /workflows?isActive=true&search=pedido

​

Respostas de Erro

​

Formato Padrão

{
  "statusCode": 400,
  "message": "Descrição do erro",
  "error": "Bad Request",
  "timestamp": "2024-01-15T10:00:00Z",
  "path": "/v1/gateway/workflows"
}

​

Códigos de Status

• 200 OK: Sucesso
• 201 Created: Recurso criado
• 400 Bad Request: Requisição inválida
• 401 Unauthorized: Autenticação falhou
• 403 Forbidden: Sem permissão
• 404 Not Found: Recurso não encontrado
• 409 Conflict: Conflito (ex: duplicado)
• 429 Too Many Requests: Rate limit excedido
• 500 Internal Server Error: Erro do servidor

​

Idempotência

POST /v1/gateway/workflows
X-Idempotency-Key: unique-key-123
{
  "name": "Meu Workflow"
}

• POST /workflows
• POST /workflow-versions
• POST /triggers

​

Webhooks

​

Endpoints Disponíveis

• Workflows: Criar, listar, obter e gerenciar workflows
• Workflow Versions: Criar, listar, obter, atualizar, deletar e publicar versões de workflows
• Triggers: Criar e gerenciar triggers para iniciar workflows
• Sub-Tenants: Criar e gerenciar sub-tenants para segmentação

​

OpenAPI Specification

​

SDKs e Bibliotecas

​

Instalação

npm install triglit

​

Uso Básico

import Triglit from 'triglit';

const client = new Triglit({ apiKey: 'pk_sua_chave_aqui' });

// Listar workflows
const workflows = await client.workflows.list();

// Criar trigger
const trigger = await client.triggers.create({
  workflowVersionId: 'version_id',
  type: 'webhook',
  config: { path: '/webhook' },
  isActive: true
});

​

Suporte

• Documentação: Esta documentação
• Email: support@triglit.com
• Status: status.triglit.com