Statt direkt mit fetch oder curl zu arbeiten, kannst du die offiziellen SDKs verwenden. Sie kapseln Auth, Retries, Pagination, Typing und Error-Handling.
TypeScript-SDK
@tolinax/ayoune-sdk ist auf npm verfügbar und voll typisiert. Es teilt sich die Interfaces mit der Plattform-internen @tolinax/ayoune-interfaces-Library — ein Feld wird also nicht "ein bisschen anders" heißen.
npm install @tolinax/ayoune-sdk
import { AyouneClient } from "@tolinax/ayoune-sdk";
const client = new AyouneClient({
token: process.env.AYOUNE_TOKEN!,
// optional: customerId, baseUrl-Override für Self-Hosted-Instanzen
});
const consumers = await client.crm.consumers.list({
filter: { _status: "active" },
limit: 50,
sort: { createdAt: -1 },
});
console.log(`Gefunden: Konsumenten`);
const created = await client.crm.consumers.create({
email: "neu@example.com",
first_name: "Max",
last_name: "Mustermann",
});
Streaming-Responses
Für große Listen unterstützt das SDK NDJSON-Streaming via async iterator:
for await (const consumer of client.crm.consumers.stream({ limit: 5000 })) {
console.log(consumer.email);
}
Self-Hosting
Bei einer Self-Hosted-Instanz reicht ein baseUrl-Override:
const client = new AyouneClient({
token,
baseUrl: "https://api.intern.firma.tld",
});
PHP-SDK
Für PHP-basierte Shops (Shopware, Magento, eigene Apps) gibt es tolinax/ayoune-php-sdk via Composer:
composer require tolinax/ayoune-php-sdk
use Tolinax\Ayoune\Client;
$client = new Client([
'token' => getenv('AYOUNE_TOKEN'),
'baseUrl' => 'https://crm-api.ayoune.app',
]);
$result = $client->module('crm')->collection('consumers')->list([
'filter' => ['_status' => 'active'],
'limit' => 50,
]);
foreach ($result->data as $consumer) {
echo $consumer->email . PHP_EOL;
}
Generated Clients
Für andere Sprachen (Go, Python, Java, …) gibt es einen OpenAPI-Generator. Die OpenAPI-Spezifikation lebt unter https://hub-api.ayoune.app/openapi.json und wird automatisch aus den createAPIHandler-Definitionen abgeleitet.
npx @openapitools/openapi-generator-cli generate \
-i https://hub-api.ayoune.app/openapi.json \
-g go \
-o ./ayoune-go-client
Versions-Strategie
Die SDKs folgen Calendar-Versioning (2026.x.y) — gleicher Rhythmus wie die Plattform. Bei größeren Änderungen findest du sie in den Release Notes.