API

API Reference

API を使うと、"API Labs." のインターフェイスから通常実行する機能を、ユーザーの Web サイトやアプリに統合できます。

APIs allow you to integrate functions normally performed from "API Labs." interface into a user's website or app.

このリファレンスガイドでは、API を実行する方法について説明しています。

This reference guide describes how to run the APIs.

API の呼び出し (Calling the API)

以下の要件が、API のリクエストに適用されます。

The following requirements apply to APIs requests.

API の基本URLはhttps://api.yuumari.com/です。

Base URL of the APIs is above url.

すべてのリクエストは、認証鍵 を指定する必要があります。

All requests must specify the Access Key.

通信は常にセキュア(https)環境で実行されます。

All connections will always run in the secure environment.

API のレスポンス (API Response)

API のレスポンスは常に json 形式で配信されます。

APIs response is always delivered in json format.

     Content-Type: application/json; charset=utf-8
    

API は常に 200 のHTTPステータスコードを返します。

APIs always returns 200.

実際のレスポンス情報は以下の内容です。

The actual response information is as follows.

    {
          "result": "<results of your request appears, if api get succeed.>"
          "message": "<error message appears, if api get failed.>"
    }
    

result

結果がセットされます。(エラーが起きた場合、データはセットされません。)

The result will be set. (If an error occurs, the data will not be set.)

message

エラーが起きた場合、エラーに関する詳細なメッセージがセットされます。(通常は空です。)

If an error occurs, some detailed message about an error will be set. (Normally empty.)

対象のURLが 404 など、原因となるメッセージがここにセットされます。

Some cause of the target URL, such as 404, will be set here, not APIs' status code.

内部エラーの場合、API は(きっと) 500系 のエラーを返すでしょう。

If some case of internal error, APIs will (maybe) returns 500 series.

Access Key

API へのアクセスは認証鍵をパラメータに含めなければアクセスできません。

API can only be accessed by specifing an Access Key as a parameter.

現在、一般ユーザー向けへの提供は行っておりません。

NO KEY for general users.

Adf.ly

Request URL

    https://api.yuumari.com/adfly/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Adf.ly

      https://api.yuumari.com/adfly/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Adfoc.us

Request URL

      https://api.yuumari.com/adfocus/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Adfoc.us

      https://api.yuumari.com/adfocus/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Bc.vc

Request URL

      https://api.yuumari.com/bcvc/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Bc.vc

      https://api.yuumari.com/bcvc/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Exe.io

Request URL

      https://api.yuumari.com/exeio/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Exe.io

      https://api.yuumari.com/exeio/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Fc.lc

Request URL

      https://api.yuumari.com/fclc/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Fc.lc

      https://api.yuumari.com/fclc/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Linkbucks.com

Request URL

    https://api.yuumari.com/linkbucks/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Linkbucks.com

      https://api.yuumari.com/linkbucs/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Link.tl

Request URL

      https://api.yuumari.com/linktl/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Link.tl

      https://api.yuumari.com/linktl/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Request URL

      https://api.yuumari.com/m-links/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Some Specific Ad-Links

      https://api.yuumari.com/m-links/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Ouo.io

Request URL

      https://api.yuumari.com/ouoio/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Ouo.io

      https://api.yuumari.com/ouoio/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Short.am

Request URL

      https://api.yuumari.com/shortam/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Short.am

      https://api.yuumari.com/shortam/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).

Shorte.st

Request URL

      https://api.yuumari.com/shst/
    

POST Parameters

NameDescriptionRequired
ltarget url (must start with http(s)://)yes
uaccess keyyes

Effective Domains for Shorte.st

      https://api.yuumari.com/shst/domains/
    

通常のアクセス(GET メソッド)で、有効なドメイン情報を json 形式で得ることができます。(認証情報は必要ありません。)

If accessed with GET method, you can get a effective domains list with json format. (No Access Key is required.)

データには有効なドメイン("accept"キー)、と無効なドメイン("drop"キー)が含まれます。

The data contains some supported domains ("accept" key) and some unsupported domains ("drop" key).