Einführung in die API

CrowdHandler stellt eine RESTful-API im JSON-Format bereit. Es gibt zwei Arten von Methoden:

Öffentliche API

Die öffentliche API dient zur Überprüfung der Benutzer auf Ihrer Website. Sie können ein Token und eine URL übermitteln, um Informationen über den Benutzer zu erhalten, der das Token vorlegt. Die Antwort gibt Auskunft darüber, ob dieser Benutzer für den Zugriff auf die URL vorab freigegeben ist oder ob er in einen Warteraum weitergeleitet werden soll. Weitere Methoden dienen dazu, die Leistung der Seite zu erfassen, damit CrowdHandler die Leistung Ihrer Domain überwachen kann.

Der Zugriff auf öffentliche Methoden erfolgt über einen öffentlichen Schlüssel, der für Ihr Konto eindeutig ist.

Alle Tarife, einschließlich des Starter-Tarifs, bieten Zugriff auf die öffentliche API.

Die öffentliche API unterliegt keiner anderen Ratenbeschränkung als der Eingangsrate für Ihre Domain.

Private API

Die Private API dient zur Verwaltung Ihres Kontos, Ihrer Domains und Ihrer Warteräume. Sie bietet Zugriff auf alle Funktionen, die über das Admin-Panel verfügbar sind, sodass Sie diese programmgesteuert nutzen können.

Der Zugriff auf private Methoden erfolgt über einen privaten Schlüssel, der für Ihr Konto einzigartig ist.

Nur einige kostenpflichtige Tarife bieten Zugriff auf private Methoden.

Die Private API unterliegt je nach Ihrem Tarif einer Ratenbegrenzung. Die Ratenbegrenzung beginnt bei 100 Aufrufen pro Minute.

Zugriff auf Ihre API-Schlüssel und die Dokumentation

Der Zugriff auf Ihre API-Schlüssel und die Dokumentation erfolgt über das Admin-Panel. Wählen Sie „Konto“ → „API“.

Nun können Sie mit der schrittweisen Umsetzung einer API-Integration beginnen.