aYOUne
← Developer Hub

Quickstart — First API Call in 5 Minutes

1. SDK installieren

npm install @tolinax/ayoune

2. API-Token erstellen

Create a Personal Access Token (PAT) in the admin UI under Settings → API Keys. The token looks like pat_... and grants access with your user's permissions.

3. Ersten Call machen

import { aYOUne } from '@tolinax/ayoune';

const ay = new aYOUne('pat_your_token_here');

// Alle Kontakte abrufen
const contacts = await ay.crm.consumers
  .find({ status: 'active' })
  .select('first_name last_name email')
  .limit(10)
  .exec();

console.log(contacts.payload());
// [{ first_name: 'Max', last_name: 'Müller', email: 'max@example.com' }, ...]

4. Daten schreiben

// Neuen Kontakt erstellen
const created = await ay.crm.consumers.create({
  first_name: 'Anna',
  last_name: 'Schmidt',
  email: 'anna@example.com',
});

console.log('Erstellt:', created.payload()._id);

// Kontakt aktualisieren
await ay.crm.consumers.updateById(created.payload()._id, {
  phone: '+49 89 123456',
});

// Kontakt löschen
await ay.crm.consumers.deleteById(created.payload()._id);

5. Ohne SDK (cURL)

# Liste abrufen
curl -H "Authorization: Bearer pat_your_token" \
  https://crm-api.ayoune.app/consumers?limit=10

# Erstellen
curl -X POST -H "Authorization: Bearer pat_your_token" \
  -H "Content-Type: application/json" \
  -d '{"entries":[{"first_name":"Anna","email":"anna@example.com"}]}' \
  https://crm-api.ayoune.app/consumers

Next Steps