API-Schlüssel

API-Schlüssel dienen der Autorisierung des Zugriffs auf die API und müssen bei jeder Anfrage enthalten sein. Es gibt zwei Arten von API-Schlüsseln:

• Kostenlose API-Schlüssel (beginnen mit ckey_..., wobei c kryptografisch bedeutet)
• Bezahlte API-Schlüssel (beginnen mit key_...)

Kostenlose API-Schlüssel

Kostenlose API-Schlüssel können kostenlos erstellt werden und gewähren begrenzten Zugriff auf die API.

Bedingungen für die Verwendung von kostenlosen API-Schlüsseln:

• Begrenzung von 200 Anfragen pro Tag (pro Domain)
• Unterliegen anderen Ratenbegrenzungen
• Attribution erforderlich

Generierung eines kostenlosen API-Schlüssels

Kostenlose API-Schlüssel sind an einen bestimmten Domainnamen gebunden und funktionieren nur auf Websites, die auf dem bereitgestellten Domainnamen gehostet werden.

Hinweis

Für kostenlose API-Schlüssel ist eine Attribution auf Ihrer Website erforderlich.

Einen kostenlosen API-Schlüssel generieren

Invalid response:

Erfolg! Machen Sie etwas Großartiges!

Download

Ihr Website-Domainname:

Generieren

Der Server generiert einen neuen kostenlosen API-Schlüssel und ein Geheimnis:

{
  "hostname": "example.com",
  "apiKey": "ckey_49960de...",
  "secret": "csec_55de16dde79f94...",
  "license": "..."
}

Das Geheimnis csec_... wird zur Payload-Verifikation (als HMAC-Schlüssel) verwendet und muss vertraulich bleiben, niemals öffentlich preisgegeben werden.

Konsultieren Sie die Dokumentation, um zu erfahren, wie Sie einen neuen API-Schlüssel über die API generieren.

Domain-Verifizierung

Obwohl optional, wird die Domain-Verifizierung dringend empfohlen. Die Überprüfung des Eigentums an Ihrem Domainnamen über den DNS TXT-Eintrag, der mit dem bereitgestellten Wert altcha-verification=... konfiguriert ist, bietet eine zusätzliche Sicherheitsebene.

Die Domain-Verifizierung stellt sicher, dass Ihr API-Schlüssel angemessen mit dem Domainnamen verknüpft ist, für den er vorgesehen ist.

Um Ihren Domainnamen zu verifizieren, befolgen Sie diese Schritte:

1. Greifen Sie auf Ihr DNS-Verwaltungspanel zu.
2. Fügen Sie einen TXT-Eintrag mit den folgenden Details hinzu:
   • Eintragstyp: TXT
   • Host/Name: @ (oder Ihr Domainname)
   • Wert/Text: altcha-verification=abc... (ersetzen Sie abc... durch Ihren eindeutigen Verifizierungstoken, den Sie erhalten haben, als Sie den API-Schlüssel generiert haben)
3. Speichern Sie die Änderungen.

Sobald der DNS-Eintrag erfolgreich hinzugefügt und verbreitet wurde, wird das Domaineigentum überprüft. Dies gewährleistet die sichere Verwendung Ihres API-Schlüssels mit dem angegebenen Domainnamen.

Attribution für kostenlose API-Schlüssel

Bei Verwendung des kostenlosen API-Schlüssels MÜSSEN Sie “Geschützt durch ALTCHA” zusammen mit dem Logo im Widget anzeigen (d. h. nicht hidelogo oder hidefooter verwenden). Wenn Sie das Widget nicht verwenden, MÜSSEN Sie eine Attribution im Footer Ihrer Website einfügen, mindestens auf der Startseite:

<a href="https://altcha.org">Geschützt durch ALTCHA</a>

Sie können den Text übersetzen oder ändern, aber er muss eine ähnliche Bedeutung wie “Geschützt durch ALTCHA” vermitteln. Der Link muss auf https://altcha.org verweisen und sollte kein rel="nofollow" enthalten.

Bezahlte API-Schlüssel

Bezahlte API-Schlüssel können innerhalb der App erstellt werden.