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.
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.
https://cpt.cx
x-api-key: YOUR_API_KEY Content-Type: application/json
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"]
}'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.
x-api-key: YOUR_API_KEY
Erstellen Sie Kurzlinks mit der Marke URL auf jeder Domain, die in Ihrem Konto registriert ist. Verwenden Sie den einzelnen Endpunkt für einen Link oder den Batch-Endpunkt, um mehrere in einer Anfrage zu generieren – ideal für SMS, RCS, WhatsApp und E-Mail-Kampagnen.
name — Zeichenfolge, erforderlichurl — Zeichenfolge, erforderlich, muss verwendet werden http oder httpsdomain — Die Zeichenfolge ist erforderlich und muss eine für Ihr Konto registrierte Domäne seintags — Array von Strings, optionalusername / password — optional, muss als Paar angegeben werden, um den Link mit einem Passwort zu schützen{
"name": "BBC News",
"url": "https://www.bbc.com/news",
"domain": "cpt.cx",
"tags": ["News", "BBC"]
}{
"name": "BBC News",
"shortUrl": "https://cpt.cx/RRRRRF",
"createdDate": "2025-07-02T15:38:02.95Z",
"expiryDate": "2025-08-01T15:38:02.95Z"
}Der Standardablauf beträgt 30 Tage ab Erstellung.
Senden Sie ein JSON-Array mit Short-Link-Objekten. Jedes Element verwendet dieselben Felder und Validierungsregeln wie der Single-Create-Endpunkt. Die Antwort enthält eine Zusammenfassung sowie ein Ergebnis für jedes Eingabeelement.
[
{
"name": "BBC News",
"url": "https://www.bbc.com/news",
"domain": "cpt.cx"
},
{
"name": "Facebook",
"url": "https://www.facebook.com",
"domain": "cpt.cx",
"tags": ["News", "World"]
}
]{
"summary": { "successCount": 2, "failedCount": 0 },
"results": [
{
"name": "BBC News",
"shortUrl": "https://cpt.cx/RRRRRT",
"createdDate": "2025-07-02T15:42:05Z",
"expiryDate": "2025-08-01T15:42:05Z"
},
{
"name": "Facebook",
"shortUrl": "https://cpt.cx/RRRRRa",
"createdDate": "2025-07-02T15:42:05Z",
"expiryDate": "2025-08-01T15:42:05Z"
}
]
}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.
channel — erforderlich, email oder smsprovider — 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-Telefonnummertype — erforderlich, numeric oder alphanumericlength — erforderlich, zwischen 4 und 12expiresInSeconds — erforderlich, muss größer als 0 sein{
"channel": "email",
"provider": "generic",
"destination": "test@example.com",
"type": "alphanumeric",
"length": 8,
"expiresInSeconds": 300
}{
"otpId": "51a6fcc7-efc8-4e69-8bc1-ebb999befb2c",
"destination": "test@example.com",
"createdAt": "2025-09-10T14:05:41Z",
"expiresAt": "2025-09-10T14:10:41Z"
}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.
{
"otpId": "c4f8814c-7a9d-4e13-b7d8-d4e66d272611",
"otp": "z4dGyBPQ"
}{
"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.
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:
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.
Wir stellen Schlüssel bereit, registrieren Ihre Domains und konfigurieren Ihre Provider – in der Regel innerhalb eines Tages.