Zum Inhalt springen
ALTCHA ALTCHA ALTCHA

API-Schlüssel

API-Schlüssel autorisieren den Zugriff auf die API und müssen bei jeder Anfrage enthalten sein. Es gibt zwei Arten:

  • Bezahlte API-Schlüssel (beginnend mit key_...)
  • Kostenlose API-Schlüssel (beginnend mit ckey_..., wobei c für kryptografisch steht)

Erstellung eines neuen API-Schlüssels

Um einen bezahlten API-Schlüssel zu erhalten, befolgen Sie diese Schritte:

  1. Melden Sie sich im ALTCHA-App unter eu.altcha.org für Kunden in der EU oder unter us.altcha.org für Kunden in den USA an.

  2. Nach der Registrierung erstellen Sie ein neues Projekt.

  3. Öffnen Sie das neu erstellte Projekt und gehen Sie zu den Projekteinstellungen:

  4. Klicken Sie auf “API-Schlüssel erstellen”, setzen Sie einen Namen und klicken Sie auf “Speichern”.

Konfiguration von API-Schlüsseln

Beim Erstellen eines neuen API-Schlüssels sehen Sie verschiedene Konfigurationsoptionen:

  • Name: Ein benutzerdefinierter Name, um den Schlüssel zu identifizieren.
  • Geheimnis: Ein Schlüsselgeheimnis zur kryptografischen Überprüfung, standardmäßig zufällig generiert.
  • Rate Limit: Ein optionales Rate-Limit, das auf alle Anfragen angewendet wird, die mit diesem Schlüssel authentifiziert sind.
  • Referrer-Domains: Eine optionale Liste erlaubter Domänennamen. Geben Sie pro Zeile eine Domain ein. Für nicht standardmäßige Ports formatieren Sie als <domain>:8080.
  • Features: Aktivieren Sie bestimmte Funktionen für diesen API-Schlüssel.

Rate-Limits

Sie können benutzerdefinierte Rate-Limits für jeden API-Schlüssel konfigurieren, ausgedrückt als Anfragen pro Intervall (<Anfragen>/<Intervall>). Zum Beispiel:

  • 100/120s: Begrenzt auf 100 Anfragen alle 120 Sekunden.
  • 100/10m: Begrenzt auf 100 Anfragen alle 10 Minuten.
  • 10/1h: Begrenzt auf 10 Anfragen pro Stunde.
  • 10/1d: Begrenzt auf 10 Anfragen pro Tag.

Wenn das Feld Rate Limit leer gelassen wird, sind unbegrenzte Anfragen möglich, jedoch gelten weiterhin globale Rate-Limits.

Funktionen

Jeder API-Schlüssel muss mindestens eine ausgewählte Funktion haben. Nur die ausgewählten Funktionen sind mit dem Schlüssel zugänglich.