Vivoldi Kurz-URL Entwickler-API

Mit der Vivoldi Entwickler-API lassen sich URL-Verkürzung, Linkverwaltung und Klick-Tracking unkompliziert per REST API und JSON-Antworten in Websites, mobile Apps und interne Systeme integrieren.

Alle APIs liefern strukturierte JSON-Daten und funktionieren reibungslos mit JavaScript, Python, Java, PHP, Android, iOS sowie nahezu jeder Entwicklungsumgebung mit HTTP-Unterstützung.

API-Authentifizierung

Für alle API-Anfragen wird ein API-Schlüssel im Authorization-Header benötigt.
Den API-Schlüssel können Sie im Dashboard auf der Seite Developer API erstellen.

Authorization: APIKey {Your API Key}

Was ist die Vivoldi Entwickler-API?

Die Vivoldi Entwickler-API ist eine REST API, mit der sich URL-Verkürzung und Linkverwaltung direkt in Websites, mobile Apps und interne Systeme integrieren lassen.

Neben der einfachen Erstellung von Kurzlinks können über die API zahlreiche Vivoldi-Funktionen automatisiert werden, darunter Klickstatistiken, Linkgruppen-Verwaltung, QR-Code-Erstellung, Coupon-Funktionen und digitale Stempel.

Typische Einsatzbereiche

  • Automatische Erstellung von Kurzlinks für Marketingkampagnen
  • Optimierte Produktlink-Freigabe in eCommerce-Plattformen
  • Automatisierte Klickauswertung und Reporting in internen Systemen
  • Kombination aus Deep Links und Kurzlinks zur Steigerung von App-Installationen
  • Automatisierte Linkverwaltung für Social Media, SMS und E-Mail-Kampagnen

Vorbereitung für die Nutzung der API

Um die Vivoldi API zu verwenden, benötigen Sie zunächst ein Konto sowie einen API-Schlüssel.
Der generierte API-Schlüssel wird im Authorization-Header übermittelt, um HTTPS-basierte REST APIs aufzurufen.

Schritt 1 — Vivoldi-Konto erstellen

Nach der Registrierung können Sie die API bereits im kostenlosen Tarif nutzen.
Bezahlte Tarife bieten höhere API-Limits sowie zusätzliche erweiterte Funktionen.

Schritt 2 — API-Schlüssel generieren

Nach dem Login können Sie Ihren API-Schlüssel im Bereich Entwickler-API im Dashboard erstellen.
Zur Sicherheit sollte der API-Schlüssel in Server-Umgebungsvariablen oder sicheren Backend-Systemen gespeichert werden.

Schritt 3 — Erste API-Anfrage testen

Fügen Sie den API-Schlüssel dem Authorization-Header hinzu und senden Sie eine POST-Anfrage an den untenstehenden Endpoint, um eine Kurz-URL zu erstellen.

Nach der Einrichtung können Sie Vivoldi mithilfe der folgenden API-Dokumentation und Beispielcodes in unterschiedliche Dienste integrieren.

Wie man die API aufruft

Die Vivoldi API basiert auf einer HTTPS-basierten REST API Architektur.
Alle Anfragen müssen Authentifizierungsinformationen über einen API Key im HTTP-Header enthalten. Als Content-Type wird application/json verwendet.

Alle Antworten werden im JSON-Format mit einer konsistenten Struktur bestehend aus code, message und result zurückgegeben.
Der Wert 0 signalisiert eine erfolgreiche Verarbeitung, während Fehlercodes und Meldungen für Exception Handling und Fehlerbehandlung genutzt werden können.

Request
Host: https://vivoldi.com/api/{uri}
Authorization: APIKey {Your API Key}
Content-type: application/json
User-Agent: {Your User-Agent}
Accept-Language: en
Response
{
	"code": 0,
	"message": "",
	"result": Object
}
Felder Beschreibung Typ
code Antwortcode. Ein Wert von 0 steht für Erfolg, jeder andere Wert bedeutet Fehler.
Dieser Code ist vom HTTP-Status unabhängig und wird nur bei einem HTTP-Status im Bereich 2xx oder 3xx zurückgegeben.
int
message Nur enthalten, wenn code ungleich 0 ist. Gibt eine Fehlermeldung zur Ursache zurück.
Bei Erfolg kann dieses Feld leer oder weggelassen sein.
string
result Die tatsächlichen Daten, die von der API zurückgegeben werden. Je nach API-Typ im Format String oder JSON-Objekt. object

Examples:

Vivoldi stellt REST API Beispielcode für verschiedene Entwicklungsumgebungen wie JavaScript, PHP und Java bereit.
Die folgenden Beispiele basieren auf der Kurz-URL-Erstellungs API (/api/v2/create) und können sofort getestet werden, indem lediglich API Key und Domain angepasst werden.

Dank der JSON-basierten Request- und Response-Struktur lässt sich die API problemlos in Websites, Admin-Dashboards, interne Systeme, Marketing-Automatisierungsplattformen und zahlreiche weitere Dienste integrieren.

<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8"/>
	<script src="https://code.jquery.com/jquery-4.0.0.min.js" crossorigin="anonymous"></script>
</head>

<body>

<form id="exampleForm">
	<button id="btnCreateLink" type="button">Create Link</button>
</form>

<script type="text/javascript">
$(function(){
	$("#btnCreateLink").on('click', function(evt){
		evt.preventDefault();

		$.ajax({
			type: 'POST',
			url: 'https://vivoldi.com/api/link/v2/create',
			data: JSON.stringify({'url':'https://google.com','domain':'https://vvd.bz'}),
			headers: {'Authorization':'APIKey oc3w9m4ytso9mv5e8yse9XXXXXXXXXX'},
			contentType: 'application/json; charset=utf-8',
			dataType: 'json',
			timeout: 5000
		}).done(function(res){
			if (res.code === 0) {
				alert('short url: ' + res.result);
			} else {
				alert('code: ' + res.code + ', message: ' + res.message);
			}
		}).fail(function(xhr, textStatus, e){
			alert('error: ' + e);
		});
	});
});
</script>

</body>
</html>
<?php
$url = "https://vivoldi.com/api/link/v2/create";
$params = array (
	"url" => "https://www.facebook.com/vivoldi365",
	"domain" => "https://vvd.bz",
);
$body = json_encode($params);

$headers = array(
	"Authorization: APIKey oc3w9m4ytso9mv5e8yse9XXXXXXXXXX",
	"Content-Type: application/json"
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 10000);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$result = curl_exec($ch);

if ($result === FALSE) {
     echo "Error sending: " . curl_error($ch);
} else {
     print_r($result);
}
curl_close($ch);
?>
package com.example;

import org.json.JSONObject;
import org.springframework.http.HttpStatus;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class CreateLink {
    public static void main(String[] args) {
        try (HttpClient client = HttpClient.newBuilder().build()) {
            JSONObject params = new JSONObject();
            params.put("url", "https://www.facebook.com/vivoldi365");
            params.put("domain", "https://vvd.bz");

            HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://vivoldi.com/api/link/v2/create"))
                .header("Content-Type", "application/json")
                .header("Authorization", "APIKey oc3w9m4ytso9mv5e8yse9XXXXXXXXXX")
                .POST(HttpRequest.BodyPublishers.ofString(params.toString()))
                .build();

            HttpResponse<String> response;
            try {
                response = client.send(request, HttpResponse.BodyHandlers.ofString());
            } catch (Exception e) {
                throw new RuntimeException(e);
            }

            if (response != null) {
                if (response.statusCode() == HttpStatus.OK.value()) {
                    String jsonString = response.body();
                    if (jsonString != null && !jsonString.isEmpty()) {
                        JSONObject json = new JSONObject(jsonString);
                        if (json.getInt("code") == 0) {
                            System.out.println("Short URL: " + json.getString("result"));
                        } else {
                            System.out.println("Failed: " + String.format("[%d] %s", json.getInt("code"), json.getString("message")));
                        }
                    }
                }
            }
        }
    }
}
Bitte kontaktieren Sie Vivoldi, wenn Sie Verbesserungen oder Änderungen an der REST API benötigen.