Installez l’application Vivoldi sur Google Play pour que ce soit encore plus pratique.

API Développeur d’URLs Courtes Vivoldi

L’API développeur Vivoldi permet d’intégrer facilement des fonctionnalités de raccourcissement d’URL, de gestion des liens et de suivi des clics dans des sites web, applications mobiles ou systèmes internes grâce à des APIs REST et des réponses JSON.

Toutes les APIs renvoient des données JSON structurées et s’intègrent facilement avec JavaScript, Python, Java, PHP, Android, iOS ainsi qu’avec pratiquement tout environnement prenant en charge les requêtes HTTP.

Authentification API

Toutes les requêtes API nécessitent une clé API dans l’en-tête Authorization.
Vous pouvez générer votre clé API depuis la page API Développeur du tableau de bord.

Authorization: APIKey {Your API Key}

Qu’est-ce que l’API Développeur Vivoldi ?

L’API développeur Vivoldi est une API REST qui permet d’intégrer facilement des fonctionnalités de raccourcissement d’URL et de gestion des liens dans des sites web, applications mobiles ou systèmes internes.

Au-delà de la simple création de liens courts, l’API permet également d’automatiser de nombreuses fonctionnalités Vivoldi, comme les statistiques de clics, la gestion des groupes de liens, la génération de QR codes, les coupons et les tampons numériques.

Principaux Cas d’Utilisation

  • Créer automatiquement des URLs courtes pour les campagnes marketing
  • Optimiser le partage de liens produits sur les plateformes e-commerce
  • Automatiser les rapports et analyses de clics dans les systèmes internes
  • Associer deep links et URLs courtes pour augmenter les installations d’applications
  • Automatiser la gestion des liens pour les réseaux sociaux, SMS et e-mails

Préparation Avant d’Utiliser l’API

Pour utiliser l’API Vivoldi, vous devez créer un compte et générer une clé API.
La clé générée peut ensuite être ajoutée dans l’en-tête Authorization pour accéder aux endpoints REST API sécurisés en HTTPS.

Étape 1 — Créer un Compte Vivoldi

Après votre inscription, vous pouvez utiliser les fonctionnalités API même avec l’offre gratuite.
Les offres payantes incluent des limites API plus élevées ainsi que des fonctionnalités avancées supplémentaires.

Étape 2 — Générer une Clé API

Une fois connecté, vous pouvez générer votre clé API depuis la section API Développeur du tableau de bord.
Pour des raisons de sécurité, il est recommandé de stocker la clé API dans des variables d’environnement serveur ou dans un backend sécurisé.

Étape 3 — Tester Votre Première Requête API

Ajoutez votre clé API dans l’en-tête Authorization puis envoyez une requête POST vers l’endpoint ci-dessous afin de créer une URL courte.

Une fois la configuration terminée, vous pourrez intégrer Vivoldi à différents services à l’aide des guides API et exemples de code ci-dessous.

Comment appeler l’API

L’API Vivoldi repose sur une architecture REST API sécurisée par HTTPS.
Toutes les requêtes doivent inclure une authentification via une API Key dans les en-têtes HTTP, avec un Content-Type défini sur application/json.

Toutes les réponses sont renvoyées au format JSON avec une structure cohérente comprenant code, message et result.
Une valeur 0 indique qu’une requête a été traitée avec succès, tandis que les codes et messages d’erreur permettent de mettre en place une gestion des exceptions et des erreurs.

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
}
Domaines Description Type
code Code de réponse. Une valeur de 0 indique un succès, toute autre valeur indique un échec.
Ce code est indépendant du statut HTTP et n’est retourné que si le statut HTTP se situe dans la plage 2xx ou 3xx.		 int
message Présent uniquement lorsque code est différent de 0. Fournit un message d’erreur expliquant la cause de l’échec.
Ce champ peut être vide ou absent en cas de réussite.		 string
result Les données renvoyées par l’API. Selon le type d’API, le format peut être une chaîne de caractères ou un objet JSON.

object

Examples:

Vivoldi fournit des exemples de code REST API pour différents environnements de développement, notamment JavaScript, PHP et Java.
Les exemples ci-dessous sont basés sur l’API de création d’URLs courtes (/api/v2/create) et peuvent être testés immédiatement en remplaçant simplement l’API Key et le domaine.

Grâce à sa structure de requêtes et de réponses basée sur JSON, l’API s’intègre facilement à des sites web, tableaux de bord d’administration, systèmes internes, plateformes d’automatisation marketing et de nombreux autres services. 

<!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")));
                        }
                    }
                }
            }
        }
    }
}
Veuillez contacter Vivoldi si vous avez besoin d’améliorations ou de modifications de l’API REST.