ホーム
サービス紹介
開発者向けAPI
料金・プラン
オンラインクーポン
Webpushの紹介

Vivoldi 開発者向けAPI

VivoldiのREST APIを使用すると、ウェブサイト、モバイルアプリ、社内システムなど、あらゆる環境で自動化されたカスタム機能を実装できます。
ダッシュボードに直接アクセスすることなく、サーバーやアプリケーション内から主要な機能をプログラム的に制御できるよう設計されています。

APIはJavaScript、Python、PHP、Java、Android、iOSなど、さまざまな言語やプラットフォームから自由に呼び出すことができます。
必要な機能は簡潔かつ直感的に提供されており、開発効率を大幅に向上させます。

APIを利用するには、認証用のAPIキーが必要です。このキーは外部に漏洩しないよう、安全に管理してください。

✨ ご参考:

  • APIキーは最大で月に1回まで変更可能です。
  • 無料プランのユーザーでもAPIを自由にご利用いただけます。
  • リクエスト頻度やレスポンス速度は、ご利用のプランによって異なる場合があります。

API呼び出し方法

Request 
Host: https://vivoldi.com/api/{uri}
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Authorization、Content-typeをHttp Headerに追加した後、APIを呼び出すことができます。
Response 
{
	"code": 0,
	"message": "",
	"result": Object
}
フィールド説明タイプ
codeレスポンスコードです。値が 0 の場合は 成功、それ以外は 失敗 を示します。
このコードは HTTPステータスとは別であり、HTTPステータスが 2xx または 3xx の場合のみ 応答本文が返されます。		int
messagecode が 0 でない場合に含まれ、失敗の理由を説明するエラーメッセージが提供されます。
成功時はこのフィールドが省略されるか、空になることがあります。		string
resultAPIから返される実際のデータです。APIの種類により、形式は 文字列 または JSONオブジェクト になります。object

Examples:

<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8"/>
	<script src="https://code.jquery.com/jquery-3.4.1.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")));
                        }
                    }
                }
            }
        }
    }
}
REST APIの改善や修正が必要な場合はVivoldiにお問い合わせください。