Flowstates messaging platform logo
    Documenten voor ontwikkelaars

    Bouw met de Flowstates-platform

    Authenticeer met een API-sleutel, maak korte URL-links met het merk, genereer eenmalige wachtwoorden en valideer deze. Naarmate het platform groter wordt, zullen er meer eindpunten worden toegevoegd.

    Snelstart

    Alle eindpunten worden bediend vanaf één basis URL. Voor elk verzoek is uw API-sleutel nodig in het bestandx-api-sleutelheader- en JSON-verzoeken gebruikenContent-Type: application/json.

    Basis URL
    https://cpt.cx
    Vereiste kopteksten
    x-api-key: YOUR_API_KEY
    Content-Type: application/json
    Maak een korte 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"]
      }'

    Authenticatie

    Elk openbaar eindpunt wordt geverifieerd met een API-sleutel die wordt verzonden in dex-api-sleutelkoptekst. Sleutels hebben betrekking op uw account, de domeinen die ervoor zijn geregistreerd en de providers die voor uw kanalen zijn geconfigureerd. Behandel sleutels als geheimen en sluit ze nooit in code aan de clientzijde in.

    Vereiste koptekst
    x-api-key: YOUR_API_KEY

    OTP API

    Genereer eenmalige wachtwoorden voor SMS of e-mailbezorging en valideer ze later met de geretourneerdeotpId. De OTP-waarde wordt nooit geretourneerd door de API; deze wordt afgeleverd bij de ontvanger en alleen opgeslagen als een hash met een TTL.

    POST/otp/generate
    Genereer een OTP

    Lichaam aanvragen

    • channel — vereist, email of sms
    • provider — vereist, de provider die voor dat kanaal in uw account is geconfigureerd (bijv. generic, twilio, sendgrid)
    • destination — vereist, e-mailadres of E.164-telefoonnummer
    • type — vereist, numeric of alphanumeric
    • length — vereist, tussen 4 en 12
    • expiresInSeconds — vereist, moet groter zijn dan 0
    Verzoek
    {
      "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
    Valideer een OTP

    Stuur deotpIdteruggestuurd door/otp/generatesamen met de OTP-waarde die de gebruiker heeft opgegeven. Een succesvolle validatie verbruikt de OTP - codes zijn voor eenmalig gebruik.

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

    Na herhaalde mislukte pogingen keert de validatie terugTe veel mislukte pogingen. Probeer het later opnieuw.totdat de tijdelijke blokkering vervalt.

    Fouten en bekende hiaten

    Validatiefouten worden geretourneerd met beschrijvende berichten zoalsOngeldig URL-formaat.ofProvider niet gevonden voor deze client en kanaal.. De volgende details zijn nog niet openbaar gedocumenteerd. Behandel ze als TODO's en neem contact met ons op als u een definitief antwoord nodig heeft voor productiegebruik:

    • Payloads voor verificatiefouten en exacte 4xx/5xx-antwoordvormen
    • Tarieflimieten per eindpunt en per account
    • Maximale batchgrootte voor het maken van korte links
    • Foutstructuur per item binnen een gedeeltelijk succesvolle batch
    • Of de vervaldatum van de korte link kan worden aangepast na de standaard 30 dagen
    • OTP tijdelijke vergrendelingsduur na te veel mislukte pogingen

    Machineleesbare assets

    Bestanden voor AI-agents, LLM-crawlers, API-clientgeneratie en technische detectie. Gelinkt vanuit de HTML-header van de site en robots.txt voor betrouwbare vindbaarheid.

    Een API-sleutel of een sandbox nodig?

    Wij leveren sleutels, registreren uw domeinen en configureren uw providers – meestal binnen een dag.