API-Dokumentation

Vollständige API-Referenz zur Integration von Snipzr in Ihre Anwendungen. Nutzen Sie unsere RESTful-API, um programmatisch Kurzlinks zu erstellen, zu verwalten und zu verfolgen.

Autorisierung

Um auf die API-Endpunkte zuzugreifen, müssen Sie Ihre Anfragen mit einem Bearer-Token authentifizieren. Fügen Sie das Token in den Authorization-Header Ihrer HTTP-Anfragen ein.

Sie können ein Token in Ihren Kontoeinstellungen generieren.

Beispiel eines Authorization-Headers:

Authorization: Bearer IHR_TOKEN_HIER

---

Erste Schritte

1. API-Token generieren: Besuchen Sie Ihre Kontoeinstellungen und generieren Sie einen neuen API-Token
2. Verbindung testen: Verwenden Sie den GET /zones-Endpunkt, um zu überprüfen, ob Ihr Token funktioniert
3. Ersten Link erstellen: Verwenden Sie den POST /urls-Endpunkt, um einen Kurzlink zu erstellen
4. Integrieren: Integrieren Sie die API in Ihre Anwendung oder Ihren Workflow

---

Endpunkte

POST /urls

Erstellen Sie einen neuen Kurzlink.

API-Endpunkt:

POST https://api.snipzr.com/v1/urls

Request Body

Parameter	Typ	Beschreibung
url	string	Die ursprüngliche URL, die verkürzt werden soll (erforderlich)
title	string	Der Titel für den Kurzlink (optional)
slug	string	Benutzerdefinierter Slug für den Kurzlink (optional)
zoneDomain	string	Zone-Domain, in der der Link erstellt wird (erforderlich)

Antwort

{
  "url": {
    "id": "string",
    "slug": "string",
    "url": "string",
    "title": "string",
    "zoneDomain": "string",
    "hits": 0,
    "isEnabled": true,
    "createdAt": "string",
    "updatedAt": "string",
    "isRestricted": true,
    "isUnsafe": true
  }
}

cURL-Befehl

curl -X POST https://api.snipzr.com/v1/urls \
-H "Authorization: Bearer IHR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "url": "https://example.com",
  "title": "Beispiel Titel",
  "slug": "beispiel-slug",
  "zoneDomain": "snipzr.com"
}'

---

PATCH /urls/:slug

Aktualisieren Sie einen vorhandenen Kurzlink.

API-Endpunkt:

PATCH https://api.snipzr.com/v1/urls/:slug

Request Body

Parameter	Typ	Beschreibung
url	string	Die neue Ziel-URL für den Kurzlink (optional)
title	string	Der neue Titel für den Kurzlink (optional)
newSlug	string	Neuer benutzerdefinierter Slug für den Kurzlink (optional)
isEnabled	boolean	Aktivieren oder deaktivieren Sie den Kurzlink (optional)

Antwort

{
  "url": {
    "id": "string",
    "slug": "string",
    "url": "string",
    "title": "string",
    "zoneDomain": "string",
    "hits": 0,
    "isEnabled": true,
    "createdAt": "string",
    "updatedAt": "string",
    "isRestricted": true,
    "isUnsafe": true
  }
}

cURL-Befehl

curl -X PATCH https://api.snipzr.com/v1/urls/beispiel-slug \
-H "Authorization: Bearer IHR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "url": "https://neue-beispiel.com",
  "title": "Aktualisierter Titel",
  "newSlug": "neue-beispiel-slug",
  "isEnabled": true
}'

---

GET /urls

Rufen Sie alle Kurzlinks mit Paginierungsunterstützung ab.

API-Endpunkt:

GET https://api.snipzr.com/v1/urls

Query-Parameter

Parameter	Typ	Beschreibung
limit	number	Anzahl der Links pro Seite (Standard: 10)
page	number	Seitennummer für die Paginierung (Standard: 1)

Antwort

{
  "urls": [
    {
      "id": "string",
      "slug": "string",
      "url": "string",
      "title": "string",
      "zoneDomain": "string",
      "hits": 0,
      "isEnabled": true,
      "createdAt": "string",
      "updatedAt": "string",
      "isRestricted": true,
      "isUnsafe": true
    }
  ],
  "total": 1
}

cURL-Befehl

curl -X GET https://api.snipzr.com/v1/urls \
-H "Authorization: Bearer IHR_TOKEN"

---

GET /urls/:slug

Rufen Sie einen einzelnen Kurzlink anhand seines Slugs ab.

API-Endpunkt:

GET https://api.snipzr.com/v1/urls/:slug

Antwort

{
  "url": {
    "id": "string",
    "slug": "string",
    "url": "string",
    "title": "string",
    "zoneDomain": "string",
    "hits": 0,
    "isEnabled": true,
    "createdAt": "string",
    "updatedAt": "string",
    "isRestricted": true,
    "isUnsafe": true
  }
}

cURL-Befehl

curl -X GET https://api.snipzr.com/v1/urls/beispiel-slug \
-H "Authorization: Bearer IHR_TOKEN"

---

DELETE /urls/:slug

Löschen Sie einen einzelnen Kurzlink dauerhaft.

API-Endpunkt:

DELETE https://api.snipzr.com/v1/urls/:slug

Antwort

{
  "message": "string"
}

cURL-Befehl

curl -X DELETE https://api.snipzr.com/v1/urls/beispiel-slug \
-H "Authorization: Bearer IHR_TOKEN"

---

GET /zones

Rufen Sie verfügbare Zonen für die Link-Erstellung ab. Gibt sowohl globale Zonen (von Snipzr bereitgestellt) als auch benutzereigene benutzerdefinierte Zonen zurück.

API-Endpunkt:

GET https://api.snipzr.com/v1/zones

Antwort

{
  "global": [
    {
      "domain": "string",
      "name": "string",
      "zoneType": "global",
      "isEnabled": true,
      "isDefault": true
    }
  ],
  "user": [
    {
      "domain": "string",
      "name": "string",
      "zoneType": "user",
      "isEnabled": true,
      "isDefault": false,
      "tlsState": "provisioned",
      "ownershipState": "verified"
    }
  ]
}

cURL-Befehl

curl -X GET https://api.snipzr.com/v1/zones \
-H "Authorization: Bearer IHR_TOKEN"

---

Antwort-Referenz

HTTP-Statuscodes

Die API gibt standardmäßige HTTP-Statuscodes zurück:

• 200: Erfolg
• 201: Erstellt (für POST-Anfragen)
• 400: Ungültige Anfrage (Validierungsfehler)
• 401: Nicht autorisiert (ungültiges oder fehlendes Token)
• 404: Nicht gefunden
• 429: Zu viele Anfragen (Ratenlimit überschritten)
• 500: Interner Serverfehler

URL-Objekt

Feld	Typ	Beschreibung
id	string	Eindeutige Kennung für den Kurzlink
slug	string	Der Kurzlink-Pfad (z.B. "beispiel-slug")
url	string	Die Ziel-URL, zu der der Kurzlink weiterleitet
title	string	Optionaler Titel zur Organisation von Links
zoneDomain	string	Die für den Kurzlink verwendete Domain (z.B. "snipzr.com")
hits	number	Anzahl der Zugriffe auf den Kurzlink
isEnabled	boolean	Ob der Link aktiv (true) oder deaktiviert (false) ist
createdAt	string	ISO-Zeitstempel der Link-Erstellung
updatedAt	string	ISO-Zeitstempel der letzten Änderung
isRestricted	boolean	Ob der Link durch Inhaltsrichtlinien eingeschränkt ist
isUnsafe	boolean	Ob das Ziel als potenziell unsicher gekennzeichnet wurde

Zonen-Objekt

Feld	Typ	Beschreibung
domain	string	Der Domainname (z.B. "snipzr.com")
name	string	Anzeigename für die Zone
zoneType	string	Entweder "global" (von Snipzr bereitgestellt) oder "user" (benutzerdefinierte Domain)
isEnabled	boolean	Ob die Zone aktiv ist
isDefault	boolean	Ob dies die Standardzone für neue Links ist
tlsState	string	SSL/TLS-Zertifikatstatus (nur Benutzerzonen)
ownershipState	string	Domain-Verifizierungsstatus (nur Benutzerzonen)

---

Support

Benötigen Sie Hilfe mit der API?

• Zonen verstehen
• Support kontaktieren