Schnellstart
Gelangen Sie in wenigen Minuten von null zu Ihrem ersten authentifizierten Aufruf.
1. Einen API-Schlüssel erstellen
Öffnen Sie in der App Settings -> Integrations -> API und erstellen Sie einen Tenant-API-Schlüssel mit dem kleinsten Scope-Satz, den Ihre Integration benötigt (zum Beispiel items:read). Das vollständige Geheimnis (pk_live_... oder pk_test_...) wird nur einmal angezeigt: speichern Sie es in Ihrem serverseitigen Secret-Manager oder in der Bereitstellungsumgebung, niemals im Client-Code oder in der Versionsverwaltung.
2. Ihren ersten Aufruf tätigen
curl https://api.fabhub.app/v1 \
-H "X-API-Key: $FABHUB_API_KEY"
GET /v1 gibt die Fähigkeiten zurück, auf die Ihre Anmeldeinformation zugreifen kann. Um die Anmeldeinformation selbst zu prüfen: ihre Scopes, ihren Plan und ihre Ratenlimit-Stufe: rufen Sie GET /v1/auth/context auf:
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. Das SDK installieren
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. Etwas erstellen (mit Idempotenz)
Schreibaufrufe nehmen einen Idempotency-Key entgegen, sodass eine wiederholte Anfrage niemals ein Duplikat erzeugt:
const { data: item } = await fabhub.createItem(
{ name: 'Widget', itemType: 'product', salePrice: 19.99 },
{ idempotencyKey: crypto.randomUUID() },
);
5. Fehler behandeln
import { FabHubApiError } from '@fabhub/sdk';
try {
await fabhub.listItems();
} catch (err) {
if (err instanceof FabHubApiError) {
console.error(err.status, err.code, err.message);
}
}
Nächste Schritte
- API-Referenz: jeder Endpunkt, Parameter und jede Antwort.
- Webhooks: empfangen Sie signierte Ereignisse, anstatt zu pollen.
- MCP: eine gescopte Tool-Oberfläche für KI-Agenten-Workflows.