Wichtigste Endpunkte

Die API ist nach Ressourcen organisiert, jede mit ihren eigenen Endpunkten. Hier ist eine Karte der wichtigsten Bereiche.

Schnellstart

Drei sofort einsatzbereite Snippets, um die externe API aufzurufen. Ersetzen Sie `yr_live_xxx` durch Ihren persönlichen Schlüssel (siehe Seite „API-Schlüssel und Authentifizierung“).

curl -X GET "https://api.yourang.ai.io/external/v1/contacts?limit=20" \
  -H "Authorization: Bearer yr_live_xxx" \
  -H "Accept: application/json"

API-Bereiche

• Kontakte. CRM-Kontakte lesen, erstellen, aktualisieren. Bidirektionale Synchronisierung mit Verwaltungssystemen, periodische Importe aus externen Quellen.
• Anrufe. Anrufhistorie mit Metadaten, Transkripten, Zusammenfassungen abrufen. Outbound-Anrufe programmatisch auslösen.
• Buchungen. Buchungen erstellen, lesen, ändern. yourang.ai-Kalender mit PMS oder Verwaltungssoftware synchronisieren.
• Bestellungen. Für das Shop-Modul: Bestellungen von externen Systemen erstellen, Status lesen, Zahlungsbestätigungen empfangen.
• Dokumente. Wissensdatenbank über die API hochladen und verwalten. Nützlich für diejenigen, die den Katalog/Preisliste in einem Quellsystem pflegen und in yourang.ai replizieren möchten.
• Webhooks. Die URLs konfigurieren, an die yourang.ai Ereignisse meldet (siehe dedizierte Seite).

Typische Anwendungsfälle

• Sync Verwaltungssoftware → yourang.ai. Jede Nacht veröffentlicht das PMS die neuen Kontakte und Buchungen des Tages an yourang.ai. Der Sprachassistent arbeitet immer mit aktuellen Daten.
• yourang.ai → Verwaltungssoftware. Wenn der Assistent eine neue Buchung erfasst, überträgt er sie über die API zurück an die zentrale Verwaltungssoftware. Der Assistent wird zu einem Eingabekanal für das zentrale System.
• Custom-Dashboard. Ein BI-Tool oder eine an die API angebundene Excel-Tabelle zeigt benutzerdefinierte aggregierte Daten an, über die des Standardpanels hinaus.
• Automatisierungen mit n8n / Make. No-Code-Workflows, die auf yourang.ai-Ereignisse reagieren, um Aktionen in anderen Systemen zu orchestrieren: Slack, Notion, Airtable.

Paginierung und Filter

Alle Listenendpunkte unterstützen Paginierung (limit + offset) und Filter auf die wichtigsten Felder. Für Massenexporte sollten Sie mit angemessenen Größen paginieren (50-100 pro Seite), anstatt alles auf einmal anzufordern: Vermeidet Timeouts und Belastung der Systeme.