Mithilfe der API kann ein Redaktionssystem eine freie Tracking-ID von Dashboard abrufen und im Gegenzug die URL des Artikels liefern.
Der Request muss als Post durchgeführt und die Parameter müssen im Post Body übergeben werden.
API URL
Diese ist kundenspezifisch und auf Anfrage bei uns erhältlich.
Parameter
Alle Parameter mit einem Stern* sind Pflicht.
auth*
Enthält den API-Key, der im Dashboard generiert werden muss.
project_domain* (1)
Basis Domain ohne Subdomain.
Beispiel: domain.de und nicht www.domain.de.
project_fulldomain* (1)
Vollständige Domain inklusive Subdomain.
Beispiel: test.domain.de
(1) project_domain ODER project_fulldomain müssen gesetzt werden. project_fulldomain sollte nur für Sonderfälle benutzt werden, wenn z.B. ein gesondertes Projekt pro Subdomain im Dashboard benutzt wird.
unique_id*
Eine eindeutige ID. Beispielsweise Permalink, Node ID, Node URL
content_url*
Die URL des Artikels (Permalink)
alternate_urls
JSON Encoded Array mit weiteren URLs
Beispiel:
["https://www.example.com/url-1","https://www.example.com/url-2.html","https://www.example.com/subdir/url-3"]user_email
E-Mail-Adresse des Users, der den Artikel erstellt hat, für die Zuordnung im Dashboard. Die Adresse muss im Dashboard existieren.
sandbox=1
Kann zum Testen der API benutzt werden.
Rückgabe der API
Die API gibt ein JSON zurück:
{"status":"OK","tracking_id":"%tracking_id%"}oder
{"status":"Warning","tracking_id":"%tracking_id%","message":"%error_message%"}oder
{"status":"Error","message":"%error_message%"}