URL kürzen
Kürzt eine Ziel-URL zu einem Kurzlink, den Sie anschließend im Text einer Nachricht oder im BulkGate Portal verwenden können.
API-URL
Die URL, an die die HTTP-Anfragen gesendet werden:
Erreicht die Anfrage ihr Ziel nicht, wiederholen Sie sie auf dem Backup-Server backup1.bulkgate.com.
Unterstützte HTTP-Methoden
POST-application/json
Für die API gilt ein Kontingent von 20 Anfragen pro Minute.
Parametertabelle
| PARAMETERNAME | WERT | PFLICHT | STANDARDWERT |
|---|---|---|---|
| application_id | Application ID | Ja | - |
| application_token | Authentifizierungstoken der Anwendung | Ja | - |
| target_url | URL, die gekürzt werden soll | Ja | - |
| url_type | Domain des Kurzlinks, siehe Unterstützte Domains | Nein | ur7.wf |
Unterstützte Domains
Die Werte von url_type sind Konfiguration der Instanz und ändern sich — die aktuelle Liste für Ihr Konto liefert der Endpoint `domains`. Zum Zeitpunkt der Erstellung dieser Seite:
| DOMAIN | EINSCHRÄNKUNG DER ZIELADRESSE |
|---|---|
ur7.wf |
Keine Einschränkung. Standardwert. |
ms6.fr |
Keine Einschränkung. |
ur7.yt |
Nur Zieldomains auf der Whitelist. |
ur7.tf |
Nur Zieldomains auf der Whitelist. |
ms6.wf |
Nur Zieldomains auf der Whitelist. |
ms6.tf |
Nur Zieldomains auf der Whitelist. |
track-message.com |
Nur Zieldomains auf der Whitelist. |
Bei den eingeschränkten Domains muss die Zieladresse auf der Whitelist Ihres Kontos stehen, sonst schlägt die Anfrage mit domain_is_not_white_listed fehl. Einige öffentliche Dienste (Google, YouTube, Facebook, GitHub und weitere) stehen immer auf der Whitelist.
Beispielanfrage
Antwort
Im Erfolgsfall:
Über die API erstellte Links sind 30 Tage gültig — expiration enthält das Ablaufdatum im Format ISO 8601.
Die drei URL-Felder bedeuten nicht dasselbe:
| FELD | WERT |
|---|---|
short_url |
Der Kurzlink selbst, zusammengesetzt aus url_type und dem generierten Schlüssel |
target_url |
Die Adresse, wie sie gespeichert wurde — ein fehlendes Schema wird ergänzt und die URL normalisiert, aus www.bulkgate.com wird also http://www.bulkgate.com/ |
final_url |
Die Adresse, die Sie gesendet haben, lediglich um das Schema ergänzt. Weiterleitungen werden nicht verfolgt, es handelt sich also nicht um die Seite, auf der der Besucher letztlich landet |
title |
Titel, der von der Zielseite ausgelesen wurde |
Im Fehlerfall:
Dabei gilt:
- type und error (Beschreibung des Fehlers) finden Sie in der Tabelle der Fehlertypen
- code ist der HTTP-Fehlercode
- detail enthält zusätzliche Informationen zum Fehler
Fehlertypen der Shortener API
Neben den allgemeinen Typen gibt die Shortener API eigene Fehlertypen zurück:
| TYP | WANN ER AUFTRITT |
|---|---|
url_is_not_valid |
target_url konnte nicht verarbeitet werden. |
url_type_is_incorrect |
url_type steht nicht in der Domainliste des Kontos. |
domain_is_not_white_listed |
Die Zieldomain steht nicht auf der Whitelist (bei eingeschränkten Domains). |
url_is_not_allowed |
Die Zieladresse verweist auf eine lokale/interne Adresse. |
url_can_not_be_redirected_out_of_target_domain |
Die Zieladresse leitet außerhalb ihrer eigenen Domain weiter. |
url_can_not_be_created |
Der Link konnte nicht erstellt werden. |
the_per_minute_quota_has_been_exceeded |
Das Kontingent von 20 Anfragen pro Minute ist aufgebraucht. |
Vielen Dank für Ihr Feedback.