Flowstates messaging platform logo
    Entwicklerdokumente

    Bauen Sie mit dem Flowstates-Plattform

    Authentifizieren Sie sich mit einem API-Schlüssel, erstellen Sie gebrandete URL-Kurzlinks, generieren Sie Einmalpasswörter und validieren Sie diese. Mit der Erweiterung der Plattform werden weitere Endpunkte hinzugefügt.

    Schnellstart

    Alle Endpunkte werden von einer einzigen Basis URL bedient. Für jede Anfrage ist Ihr API-Schlüssel erforderlichx-API-SchlüsselVerwendung von Header- und JSON-AnfragenContent-Type: application/json.

    Basis URL
    https://cpt.cx
    Erforderliche Header
    x-api-key: YOUR_API_KEY
    Content-Type: application/json
    Erstellen Sie einen kurzen Link
    curl -X POST "https://cpt.cx/shortlink/public-generate" \
      -H "x-api-key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "name": "BBC News",
        "url": "https://www.bbc.com/news",
        "domain": "cpt.cx",
        "tags": ["News", "BBC"]
      }'

    Authentifizierung

    Jeder öffentliche Endpunkt wird mit einem API-Schlüssel authentifiziert, der im gesendet wirdx-API-SchlüsselKopfzeile. Die Schlüssel beziehen sich auf Ihr Konto, die dafür registrierten Domänen und die für Ihre Kanäle konfigurierten Anbieter. Behandeln Sie Schlüssel als Geheimnisse – betten Sie sie niemals in clientseitigen Code ein.

    Erforderlicher Header
    x-api-key: YOUR_API_KEY

    OTP API

    Generieren Sie Einmalpasswörter für SMS oder den E-Mail-Versand und validieren Sie diese später mit den zurückgegebenen PasswörternotpId. Der OTP-Wert wird nie vom API zurückgegeben – er wird an den Empfänger übermittelt und nur als Hash mit einem TTL gespeichert.

    POST/otp/generate
    Generieren Sie einen OTP

    Anforderungstext

    • channel — erforderlich, email oder sms
    • provider — erforderlich, der Anbieter, der für diesen Kanal in Ihrem Konto konfiguriert ist (z. B. generic, twilio, sendgrid)
    • destination — erforderlich, E-Mail-Adresse oder E.164-Telefonnummer
    • type — erforderlich, numeric oder alphanumeric
    • length — erforderlich, zwischen 4 und 12
    • expiresInSeconds — erforderlich, muss größer als 0 sein
    Anfrage
    {
      "channel": "email",
      "provider": "generic",
      "destination": "test@example.com",
      "type": "alphanumeric",
      "length": 8,
      "expiresInSeconds": 300
    }
    200 OK
    {
      "otpId": "51a6fcc7-efc8-4e69-8bc1-ebb999befb2c",
      "destination": "test@example.com",
      "createdAt": "2025-09-10T14:05:41Z",
      "expiresAt": "2025-09-10T14:10:41Z"
    }
    POST/otp/validate
    Validieren Sie einen OTP

    Senden Sie dieotpIdzurückgegeben von/otp/generatezusammen mit dem vom Benutzer angegebenen OTP-Wert. Eine erfolgreiche Validierung verbraucht den OTP – Codes sind zur einmaligen Verwendung bestimmt.

    Anfrage
    {
      "otpId": "c4f8814c-7a9d-4e13-b7d8-d4e66d272611",
      "otp": "z4dGyBPQ"
    }
    200 OK
    {
      "success": true,
      "message": "OTP validated successfully."
    }

    Nach wiederholten Fehlversuchen wird die Validierung wiederhergestelltZu viele gescheiterte Versuche. Versuchen Sie es später noch einmal.bis die vorübergehende Sperre abläuft.

    Fehler und bekannte Lücken

    Validierungsfehler werden mit beschreibenden Meldungen zurückgegeben, z. BUngültiges URL-Format.oderFür diesen Kunden und Kanal wurde kein Anbieter gefunden.. Die folgenden Details sind noch nicht öffentlich dokumentiert – behandeln Sie sie als TODOs und kontaktieren Sie uns, wenn Sie eine endgültige Antwort für den Produktionseinsatz benötigen:

    • Payloads für Authentifizierungsfehler und genaue 4xx/5xx-Antwortformen
    • Ratenlimits pro Endpunkt und pro Konto
    • Maximale Batchgröße für die Erstellung von Kurzlinks
    • Fehlerstruktur pro Artikel innerhalb eines teilweise erfolgreichen Stapels
    • Ob der Ablauf des Short-Links über die standardmäßigen 30 Tage hinaus angepasst werden kann
    • OTP temporäre Sperrdauer nach zu vielen Fehlversuchen

    Maschinenlesbare Vermögenswerte

    Dateien für AI-Agenten, LLM-Crawler, API-Client-Generierung und technische Erkennung. Zur zuverlässigen Auffindbarkeit über den HTML-Header und robots.txt der Website verlinkt.

    Benötigen Sie einen API-Schlüssel oder eine Sandbox?

    Wir stellen Schlüssel bereit, registrieren Ihre Domains und konfigurieren Ihre Provider – in der Regel innerhalb eines Tages.