Zum Hauptinhalt gehen

API Referenz

  • Aktualisiert

Authentifizierung

Ihr Projekt verfügt über einen geheimen API-Schlüssel, den Sie verwenden können, um Ihre Anfragen zu authentifizieren. Sie finden Ihren API-Schlüssel hier: Einstellungen > API

Fügen Sie Ihren API-Schlüssel in den Authorization-Header jeder Anfrage ein, z. B.:

"Authorization": "Bearer <API_KEY>"

 

Endpunkte

Kunden

Einen Kunden erstellen oder aktualisieren

POST https://api.bewertungsbox.com/beacon/customers

Erstellt einen neuen Kunden oder aktualisiert einen bestehenden Kunden.

Name Typ Beschreibung
first_name* string Der Vorname des Kunden.
last_name string Der Nachname des Kunden.
email string E-Mail-Adresse des Kunden.
phone string Telefonnummer des Kunden.
company string Firmenname des Kunden.
signed_up_at date Das Datum, an dem sich der Kunde angemeldet hat.
has_subscription boolean Ob der Kunde ein aktives Abonnement hat.
location_slug string Der Slug eines Standorts.
notes string Notizen, nur für die interne Verwendung.
tags array Eine Reihe von Kunden-Tags, die auf den Kunden angewendet werden sollen.
address1 string Die erste Adresszeile des Kunden.
address2 string Die zweite Adresszeile des Kunden.
city string Die Stadt des Kunden.
state string Das Bundesland des Kunden.
postal_code string Die PLZ des Kunden.

 

Eine Kundenbelastung erfassen

POST https://api.bewertungsbox.com/beacon/charges

Erfasst eine Belastung (Charge) für den Kunden. Der Kunde muss zuvor erstellt worden sein.

Name Typ Beschreibung
email string, erforderlich ohne Telefon E-Mail-Adresse des Kunden.
phone string, erforderlich ohne E-Mail Telefonnummer des Kunden.
amount integer Betrag der Belastung in kleinster Währungseinheit.
currency string Dreistelliger Währungscode.
location_slug string Der Slug eines Standorts.
charged_at date Datum der Belastung.

 

Kunden abrufen

GET https://api.bewertungsbox.com/beacon/customers

Ruft alle Kunden eines Projekts ab.

 

Kundenbewertungen abrufen

GET https://api.bewertungsbox.com/beacon/customers/:id/reviews

Ruft alle Bewertungen des Kunden ab, die er hinterlassen hat.

 

Kunden-Nachrichten abrufen

GET https://api.bewertungsbox.com/beacon/customers/:id/messages

Ruft alle Nachrichten ab, die an den Kunden gesendet wurden.

 

Bewertungen

Eine Bewertungsanfrage erstellen

POST https://api.bewertungsbox.com/beacon/asks

Plant eine Bewertungsanfrage für den Kunden.

Name Typ Beschreibung
email string, erforderlich ohne Telefon E-Mail-Adresse des Kunden.
phone string, erforderlich ohne E-Mail Telefonnummer des Kunden.
channels array Einschluss von "email", "sms" oder beiden Kanälen.
reminders_count integer 0–3 Erinnerungen.
asked_at date Datum der geplanten Anfrage. Wird null gesetzt, erfolgt sofort.

 

Bewertungen abrufen

GET https://api.bewertungsbox.com/beacon/reviews/

Ruft alle Bewertungen eines Projekts ab.

 

Standorte

Einen Standort erstellen

POST https://api.bewertungsbox.com/beacon/locations

Erstellt einen Standort für ein Projekt.

Name Typ Beschreibung
name string Name des Standorts.
display_name string Kundensichtbarer Name für den Standort. Fällt auf name zurück, falls leer.
slug string Slug für den Standort (generiert, falls leer).
code string Optionaler Store-Code für den Standort.
address1 string Adresszeile 1.
address2 string Adresszeile 2.
city string Stadt oder Ort.
state string Bundesland oder Region.
zip string Postleitzahl.

 

Einen Standort updaten

PUT https://api.bewertungsbox.com/beacon/locations/:id

Aktualisiert einen Standort.

Name Typ Beschreibung
name* string Name des Standorts.
display_name string Kundensichtbarer Name für den Standort. Fällt auf name zurück, falls leer.
slug string Slug für den Standort (generiert, falls leer).
code string Optionaler Store-Code für den Standort.
address1 string Adresszeile 1.
address2 string Adresszeile 2.
city string Stadt oder Ort.
state string Bundesland oder Region.
zip string Postleitzahl.

 

Paginierung

Bei Anfragen, die eine Paginierung erfordern, wird der Antwort ein Paginierungsschlüssel hinzugefügt. Dieser Schlüssel könnte etwa wie folgt aussehen:

"pagination": {
  "current_page": 2,
  "path": "https://api.bewertungsbox.com/beacon/customers",
  "first_page_url": "https://api.bewertungsbox.com/beacon/customers?page=1",
  "last_page_url": "https://api.bewertungsbox.com/beacon/customers?page=3",
  "prev_page_url": "https://api.bewertungsbox.com/beacon/customers?page=1",
  "next_page_url": "https://api.bewertungsbox.com/beacon/customers?page=3",
  "from": 51,
  "to": 100,
  "total": 110,
  "per_page": 50,
  "last_page": 3
}

 

Verwandte Beiträge