Erste Schritte

Was ist das CRM-API?

CRM API — HTTP-API mit Antworten im JSON-Format. Über dieses API arbeitet ein externes System mit denselben Daten wie das CRM FoodSoul: Es liest, erstellt und ändert sie im Namen des Accounts.

Alle Anfragen werden per HTTPS an die Adresse https://foodsoul.pro/api/crm/v2 gesendet.

Das API-Handbuch beschreibt jede Methode: Parameter, Anfrage-Body, Antworten sowie Beispiele in curl, PHP, JavaScript und Python. Die vollständige API-Dokumentation kann im OpenAPI-Format heruntergeladen und in Postman, Insomnia oder einen SDK-Generator eingebunden werden.

Wie erhält man ein API-Token?

Integrationsanfragen werden mit einem API-Token autorisiert. Der Token wird vom Inhaber oder Administrator des Kontos im CRM im Bereich „API-Tokens“ ausgestellt.

1. Öffnen Sie in der CRM den Bereich „API-Tokens“ und erstellen Sie ein Token.
2. Wählen Sie die Rolle des Tokens aus: Davon hängen die verfügbaren Methoden ab. Die Rolle eines ausgestellten Tokens kann nicht geändert werden.
3. Damit das Token nur mit einem Netzwerk funktioniert, wählen Sie dieses aus. Ohne die Auswahl eines Netzwerks steht das Token allen Netzwerken des Kontos zur Verfügung, und Anfragen übermitteln das Netzwerk im Header chain.
4. Bei Bedarf legen Sie die Gültigkeitsdauer des Tokens und die erlaubten IP-Adressen fest.
5. Kopieren Sie das Token sofort nach der Erstellung: Der offene Wert wird nur einmal angezeigt und kann nicht wiederhergestellt werden.

Das Token beginnt mit fs_api_ und wird im Header Authorization: Bearer <Token> übermittelt. Das Token wird wie ein Passwort behandelt: Veröffentlichen Sie es nicht im Code von Websites oder mobilen Anwendungen und geben Sie es nicht an Dritte weiter. Ein verlorenes Token sperren oder löschen Sie im selben Bereich des CRM.

Erste Anfrage

Überprüfen Sie das Token mit der Anfrage „Benutzerdaten abrufen“. Ersetzen Sie fs_api_YOUR_TOKEN durch Ihr eigenes Token.

Neben dem Token überträgt jede Anfrage die Header role — die Rolle für diese API partner und language — die Sprache der Texte in der Antwort, zum Beispiel de.

curl -X GET 'https://foodsoul.pro/api/crm/v2/application.user_info' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: de' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/application.user_info', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'de',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/application.user_info", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/application.user_info",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner",
    },
)
data = response.json()

Erfolgreiche Antwort — HTTP 200 und ein JSON mit status: success, die Daten befinden sich im Feld data. Im Fehlerfall ist status gleich error, und der Fehlercode sowie der Fehlertext befinden sich im Feld error.

Beschreibung der Methode: Benutzerdaten abrufen →

Was kommt als Nächstes

• API-Referenz — alle Methoden mit Parametern, Antworten und Beispielanfragen
• Authentifizierung — autorisierungsüberschriften und Sätze, die Methoden akzeptieren
• Webhooks — benachrichtigungen über Ereignisse an die Adresse Ihres Systems
• Fehler — fehlercodes und ihre Bedeutungen
• Änderungen — was hat sich in der API geändert?
• OpenAPI herunterladen · YAML