Zum Hauptinhalt springen
Dieser Artikel beschreibt eine Integrationsbeschreibung für die Short URL API, die lange URLs in kurze URLs umwandeln kann.

​
Antragsprozess

Um die API zu nutzen, müssen Sie zunächst auf die entsprechende Seite der Short URL API gehen und den entsprechenden Dienst beantragen. Nachdem Sie die Seite betreten haben, klicken Sie auf die Schaltfläche „Acquire“, wie im Bild gezeigt: Wenn Sie noch nicht angemeldet oder registriert sind, werden Sie automatisch zur Anmeldeseite weitergeleitet, um sich zu registrieren und anzumelden. Nach der Anmeldung werden Sie automatisch zur aktuellen Seite zurückgeleitet. Bei der ersten Beantragung gibt es ein kostenloses Kontingent, das Sie nutzen können, um die API kostenlos zu verwenden.

​
Grundlegende Nutzung

Zunächst sollten Sie die grundlegende Nutzung verstehen, indem Sie die lange URL eingeben, die Sie umwandeln möchten, um das verarbeitete Ergebnis zu erhalten. Zunächst müssen Sie einfach ein content-Feld übermitteln. Wir können dann die entsprechenden Inhalte auf der Benutzeroberfläche ausfüllen, wie im Bild gezeigt:

Hier haben wir die Request Headers festgelegt, einschließlich:
  • accept: In welchem Format Sie die Antwort erhalten möchten, hier eingetragen als application/json, also im JSON-Format.
  • authorization: Der Schlüssel zur Nutzung der API, den Sie nach der Beantragung direkt auswählen können.
Außerdem haben wir den Request Body festgelegt, einschließlich:
  • content: Der Inhalt der URL, die verkürzt werden soll.
Nach der Auswahl können Sie feststellen, dass auf der rechten Seite auch der entsprechende Code generiert wurde, wie im Bild gezeigt:

Klicken Sie auf die Schaltfläche „Try“, um einen Test durchzuführen. Wie im obigen Bild gezeigt, haben wir folgendes Ergebnis erhalten: 
{
  "success": true,
  "data": {
    "url": "https://surl.id/1uHCs01xa5"
  }
}
Die Rückgabe enthält mehrere Felder, die wie folgt beschrieben werden:
  • success, der Status, ob die Aufgabe erfolgreich war.
  • data, das die umgewandelte URL enthält.
Es ist zu erkennen, dass die ursprünglich lange URL https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9 erfolgreich in die kurze URL https://surl.id/1uHCs01xa5 umgewandelt wurde. Wenn Sie außerdem den entsprechenden Integrationscode generieren möchten, können Sie ihn direkt kopieren, zum Beispiel sieht der CURL-Code wie folgt aus: 
curl -X POST 'https://api.acedata.cloud/shorturl' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "content": "https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9"
}'
Der Integrationscode in Python sieht wie folgt aus: 
import requests

url = "https://api.acedata.cloud/shorturl"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "content": "https://platform.acedata.cloud/documents/a2303356-6672-4eb8-9778-75f55c998fe9"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Fehlerbehandlung

Wenn beim Aufruf der API ein Fehler auftritt, gibt die API den entsprechenden Fehlercode und die Informationen zurück. Zum Beispiel:
  • 400 token_mismatched: Ungültige Anfrage, möglicherweise aufgrund fehlender oder ungültiger Parameter.
  • 400 api_not_implemented: Ungültige Anfrage, möglicherweise aufgrund fehlender oder ungültiger Parameter.
  • 401 invalid_token: Unbefugt, ungültiger oder fehlender Autorisierungstoken.
  • 429 too_many_requests: Zu viele Anfragen, Sie haben das Kontingent überschritten.
  • 500 api_error: Interner Serverfehler, etwas ist auf dem Server schiefgelaufen.

​
Beispiel für eine Fehlerantwort

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Fazit

Durch dieses Dokument haben Sie gelernt, wie Sie die Short URL API verwenden, um lange URLs in kurze URLs umzuwandeln. Wir hoffen, dass dieses Dokument Ihnen hilft, die API besser zu integrieren und zu nutzen. Bei Fragen wenden Sie sich bitte jederzeit an unser technisches Support-Team.