Quickstart
Vá de zero à sua primeira chamada autenticada em poucos minutos.
1. Criar uma chave de API
Na aplicação, abra Settings -> Integrations -> API e crie uma chave de API de tenant com o conjunto de scopes mais reduzido de que a sua integração precisa (por exemplo items:read). O segredo completo (pk_live_... ou pk_test_...) é mostrado uma única vez: guarde-o no seu gestor de segredos do lado do servidor ou no ambiente de implementação, nunca em código de cliente ou no controlo de versões.
2. Fazer a sua primeira chamada
curl https://api.fabhub.app/v1 \
-H "X-API-Key: $FABHUB_API_KEY"
GET /v1 devolve as capacidades a que a sua credencial pode aceder. Para inspecionar a própria credencial: os seus scopes, plano e nível de limite de taxa: chame GET /v1/auth/context:
curl https://api.fabhub.app/v1/auth/context \
-H "X-API-Key: $FABHUB_API_KEY"
{
"data": {
"tenant": { "id": "0e2b...c1", "plan": "pro" },
"api_key": {
"id": "key_8f...",
"prefix": "pk_live_8f3a",
"environment": "production",
"scopes": ["items:read", "items:write", "webhooks:write"],
"rate_limit_tier": "standard",
"expires_at": null
}
}
}
3. Instalar o SDK
npm install @fabhub/sdk
import { FabHubClient } from '@fabhub/sdk';
const fabhub = new FabHubClient({ apiKey: process.env.FABHUB_API_KEY });
// List the first page of items
const items = await fabhub.listItems({ pageSize: 20 });
console.log(items.data.length, 'of', items.pagination.total);
// Read your organization
const { data: organization } = await fabhub.getOrganization();
console.log(organization.name, organization.plan);
4. Criar algo (com idempotência)
As chamadas de escrita aceitam um Idempotency-Key para que um pedido repetido nunca crie um duplicado:
const { data: item } = await fabhub.createItem(
{ name: 'Widget', itemType: 'product', salePrice: 19.99 },
{ idempotencyKey: crypto.randomUUID() },
);
5. Tratar erros
import { FabHubApiError } from '@fabhub/sdk';
try {
await fabhub.listItems();
} catch (err) {
if (err instanceof FabHubApiError) {
console.error(err.status, err.code, err.message);
}
}
Próximos passos
- Referência da API: todos os endpoints, parâmetros e respostas.
- Webhooks: receba eventos assinados em vez de sondar.
- MCP: uma superfície de ferramentas com scope para fluxos de trabalho de agentes de IA.