Avvio rapido
Passa da zero alla tua prima chiamata autenticata in pochi minuti.
1. Crea una chiave API
Nell'app, apri Impostazioni -> Integrazioni -> API e crea una chiave API del tenant con l'insieme di scope più ridotto di cui la tua integrazione ha bisogno (ad esempio items:read). Il segreto completo (pk_live_... o pk_test_...) viene mostrato una sola volta: conservalo nel tuo gestore di segreti server-side o nell'ambiente di deployment, mai nel codice client o nel controllo di versione.
2. Effettua la tua prima chiamata
curl https://api.fabhub.app/v1 \
-H "X-API-Key: $FABHUB_API_KEY"
GET /v1 restituisce le funzionalità a cui la tua credenziale può accedere. Per ispezionare la credenziale stessa: i suoi scope, il piano e il livello di rate limit: chiama 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. Installa l'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. Crea qualcosa (con idempotenza)
Le chiamate di scrittura accettano un Idempotency-Key affinché una richiesta ripetuta non crei mai un duplicato:
const { data: item } = await fabhub.createItem(
{ name: 'Widget', itemType: 'product', salePrice: 19.99 },
{ idempotencyKey: crypto.randomUUID() },
);
5. Gestisci gli errori
import { FabHubApiError } from '@fabhub/sdk';
try {
await fabhub.listItems();
} catch (err) {
if (err instanceof FabHubApiError) {
console.error(err.status, err.code, err.message);
}
}
Passi successivi
- Riferimento API: ogni endpoint, parametro e risposta.
- Webhook: ricevi eventi firmati invece di fare polling.
- MCP: una superficie di strumenti con scope per i flussi di lavoro degli agenti IA.