Autenticação

A IronFlock API usa API keys para autenticação. Inclua sua API key em cada requisição como um Bearer token no header Authorization.

Criando uma API Key

1. Vá para Account Settings → API Keys
2. Clique em Create API Key
3. Dê um nome descritivo (ex.: “CI/CD Pipeline”, “Dashboard Externo”)
4. Copie a key gerada — ela é mostrada apenas uma vez

Usando a API Key

Inclua a key no header HTTP Authorization:

curl -H "Authorization: Bearer SEU_API_KEY" \
  https://api.ironflock.com/v1/ironflock/devices

Com bibliotecas HTTP:

import httpx
 
client = httpx.Client(
    base_url="https://api.ironflock.com/v1/ironflock",
    headers={"Authorization": f"Bearer {api_key}"}
)
 
devices = client.get("/devices").json()

Gerenciando API Keys

• Rotacionar keys regularmente por segurança
• Revogar keys que não são mais necessárias em Account Settings → API Keys
• Use uma key separada por aplicação ou pipeline para facilitar a revogação

Limites de Taxa

As requisições da API são limitadas por conta. Os headers de resposta incluem informações sobre o uso atual:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 998
X-RateLimit-Reset: 1699900800