# Developers
**Source:** https://ja.urlkai.com/developers
**Language:** Japanese

---

はじめ 

認証 

レート制限 

レスポンス処理 

###### アカウント

アカウントを取得 

アカウントの更新

###### ブランドドメイン

ブランドドメインの一覧表示 

ブランドドメインの作成 

ドメインの更新 

ドメインの削除

###### CTAオーバーレイ

CTAオーバーレイの一覧表示

###### キャンペーン

キャンペーンのリスト 

キャンペーンの作成 

キャンペーンへのリンクの割り当て 

アップデートキャンペーン 

キャンペーンの削除

###### チャンネル

チャンネルのリスト 

チャンネルアイテムの一覧表示 

チャネルの作成 

チャネルへのアイテムの割り当て 

更新チャネル 

チャネルの削除

###### カスタムスプラッシュ

カスタムスプラッシュのリスト

###### ファイル

リストファイル 

ファイルをアップロードする

###### リンクス

リンクを一覧表示する 

単一のリンクを取得する 

リンクを短縮する 

更新リンク 

リンクの削除

###### ピクセル

ピクセルのリスト 

ピクセルを作成する 

ピクセルを更新 

ピクセルの削除

###### QRコード

QRコードを一覧表示する 

QRコードを1つ取得 

QRコードを作成する 

QRコードの更新 

QRコードを削除する

#### 開発者向け API リファレンス

###### はじめ

API キーは、システムによって要求を処理するために必要です。ユーザーが登録すると、このユーザーの API キーが自動的に生成されます。API キーは、リクエストごとに送信する必要があります (以下の完全な例を参照)。APIキーが送信されていないか、有効期限が切れている場合は、エラーが発生します。不正使用を防ぐために、APIキーを秘密にしてください。

###### 認証

API システムで認証するには、リクエストごとに API キーを認証トークンとして送信する必要があります。以下のサンプルコードをご覧ください。

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/account' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/account"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "POST"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
));

$response = curl_exec($curl);
```

```
var request = require('request');
var オプション = {
    'メソッド': '投稿',
    'url': 'https://urlkai.com/api/account',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: ''
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/account"
ペイロード = {}
ヘッダー = {
  '認証': 'ベアラー YOURAPIKEY',
  'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### レート制限

API には、リクエストの急増を防ぎ、安定性を最大限に高めるためのレート リミッターがあります。現在、レートリミッターの上限は1分あたり30リクエストです。ご加入のプランによって料金が変更になる場合がありますので、予めご了承ください。

いくつかのヘッダーが応答と共に送信され、これらを調べてリクエストに関するさまざまな情報を特定できます。

```
X-RateLimit-Limit: 30  
X-RateLimit-Remaining: 29  
X-RateLimit-Reset: TIMESTAMP
```

###### レスポンス処理

デフォルトでは、すべてのAPIレスポンスがJSON形式で返されます。これを使用可能なデータに変換するには、言語に応じて適切な関数を使用する必要があります。PHP では、関数 json\_decode() を使用して、データをオブジェクト (デフォルト) または配列 (2 番目のパラメーターを true に設定) に変換できます。エラーキーを確認することは非常に重要です。エラーキーは、エラーが発生したかどうかに関する情報を提供するためです。ヘッダーコードも確認できます。

```
{
    "error": 1,
    "message": "An error occurred"
}
```

---

#### アカウント - Open in ChatGPT - Open in Claude

###### アカウントを取得

取得  `https://urlkai.com/api/account`

アカウントに関する情報を取得するには、このエンドポイントにリクエストを送信すると、アカウントのデータが返されます。

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/account' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/account"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/account',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/account"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "データ": {
        "id": 1,
        "メール": " [メール保護] ",
        "username": "sampleuser",
        "アバター": "https:\/\/domain.com\/content\/avatar.png",
        "ステータス": "プロ",
        "有効期限": "2022-11-15 15:00:00",
        「登録済み」: 「2020-11-10 18:01:43」
    }
}
```

###### アカウントの更新

置く  `https://urlkai.com/api/account/update`

アカウントの情報を更新するには、このエンドポイントにリクエストを送信すると、アカウントのデータが更新されます。

cURL
PHP
Node.js
Python
C#

```
curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "メール": " [メール保護] ",
    "password": "newpassword"
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/account/update"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "PUT"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "メール": " [メール保護] ",
	    "password": "newpassword"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '置く',
    'url': 'https://urlkai.com/api/account/update',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "メール": " [メール保護] ",
    "password": "newpassword"
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/account/update"
ペイロード = {
    "メール": " [メール保護] ",
    "password": "newpassword"
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "メール": " [メール保護] ",
    "password": "newpassword"
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "アカウントが正常に更新されました。"
}
```

---

#### ブランドドメイン - Open in ChatGPT - Open in Claude

###### ブランドドメインの一覧表示

取得  `https://urlkai.com/api/domains?limit=2&page=1`

API を介してブランド化されたドメインを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/domains?limit=2&page=1"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        "domains": [
            {
                "id": 1,
                "ドメイン": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "ドメイン": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
}
```

###### ブランドドメインの作成

投稿  `https://urlkai.com/api/domain/add`

ドメインは、このエンドポイントを使用して追加できます。ドメインがサーバーを正しく指していることを確認してください。

| **パラメーター** | **形容** |
| --- | --- |
| ドメイン | (必須)httpまたはhttpsを含むブランドドメイン |
| リダイレクトルート | (オプション)誰かがあなたのドメインにアクセスしたときのルートリダイレクト |
| リダイレクト404 | (オプション)カスタム 404 リダイレクト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "ドメイン": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/domain/add"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "POST"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "ドメイン": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '投稿',
    'url': 'https://urlkai.com/api/domain/add',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "ドメイン": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/domain/add"
ペイロード = {
    "ドメイン": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "ドメイン": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "id": 1
}
```

###### ドメインの更新

置く  `https://urlkai.com/api/domain/:id/update`

ブランド化されたドメインを更新するには、PUTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| リダイレクトルート | (オプション)誰かがあなたのドメインにアクセスしたときのルートリダイレクト |
| リダイレクト404 | (オプション)カスタム 404 リダイレクト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "PUT"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '置く',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/domain/:id/update"
ペイロード = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "ドメインが正常に更新されました。"
}
```

###### ドメインの削除

削除  `https://urlkai.com/api/domain/:id/delete`

ドメインを削除するには、DELETE リクエストを送信する必要があります。

cURL
PHP
Node.js
Python
C#

```
curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "削除",
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '削除',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/domain/:id/delete"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("削除", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "ドメインは正常に削除されました。"
}
```

---

#### CTAオーバーレイ - Open in ChatGPT - Open in Claude

###### CTAオーバーレイの一覧表示

取得  `https://urlkai.com/api/overlay?limit=2&page=1`

API を介して cta オーバーレイを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/overlay?limit=2&page=1"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        「cta」: [
            {
                "id": 1,
                "タイプ": "メッセージ",
                "name": "製品1プロモーション",
                "日付": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "タイプ": "連絡先",
                "name": "お問い合わせページ",
                "日時": "2020-11-10 18:10:00"
            }
        ]
    }
}
```

---

#### キャンペーン - Open in ChatGPT - Open in Claude

###### キャンペーンのリスト

取得  `https://urlkai.com/api/campaigns?limit=2&page=1`

API経由でキャンペーンを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        「キャンペーン」: [
            {
                "id": 1,
                "name": "サンプルキャンペーン",
                "public": false,
                "rotator": false,
                "リスト": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "ドメイン": "Facebookキャンペーン",
                "public": true です。
                "ローテーター": "https:\/\/domain.com\/r\/test",
                "リスト": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
}
```

###### キャンペーンの作成

投稿  `https://urlkai.com/api/campaign/add`

キャンペーンは、このエンドポイントを使用して追加できます。

| **パラメーター** | **形容** |
| --- | --- |
| 名前 | (オプション)キャンペーン名 |
| 蛞蝓 | (オプション)ローテータースラッグ |
| 公共 | (オプション)アクセス |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "New Campaign",
	    "slug": "new-campaign",
	    "public": true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
import requests
url = "https://urlkai.com/api/campaign/add"
payload = {
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)
```

```
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "error": 0,
    "id": 3,
    "domain": "New Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}
```

###### キャンペーンへのリンクの割り当て

投稿  `https://urlkai.com/api/campaign/:campaignid/assign/:linkid`

短縮リンクは、このエンドポイントを使用してキャンペーンに割り当てることができます。エンドポイントには、キャンペーン ID と短縮リンク ID が必要です。

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "POST"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '投稿',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "キャンペーンにリンクが追加されました。"
}
```

###### アップデートキャンペーン

置く  `https://urlkai.com/api/campaign/:id/update`

キャンペーンを更新するには、PUTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 名前 | (必須)キャンペーン名 |
| 蛞蝓 | (オプション)ローテータースラッグ |
| 公共 | (オプション)アクセス |

cURL
PHP
Node.js
Python
C#

```
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "name": "Twitterキャンペーン",
    "スラッグ": "Twitterキャンペーン",
    "public": 真
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "PUT"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "name": "Twitterキャンペーン",
	    "スラッグ": "Twitterキャンペーン",
	    "public": 真
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '置く',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "name": "Twitterキャンペーン",
    "スラッグ": "Twitterキャンペーン",
    "public": 真
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/campaign/:id/update"
ペイロード = {
    "name": "Twitterキャンペーン",
    "スラッグ": "Twitterキャンペーン",
    "public": 真
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "name": "Twitterキャンペーン",
    "スラッグ": "Twitterキャンペーン",
    "public": 真
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "id": 3,
    "domain": "Twitterキャンペーン",
    "public": true です。
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "リスト": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
}
```

###### キャンペーンの削除

削除  `https://urlkai.com/api/campaign/:id/delete`

キャンペーンを削除するには、DELETE リクエストを送信する必要があります。

cURL
PHP
Node.js
Python
C#

```
curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "削除",
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '削除',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/campaign/:id/delete"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("削除", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "キャンペーンは正常に削除されました。"
}
```

---

#### チャンネル - Open in ChatGPT - Open in Claude

###### チャンネルのリスト

取得  `https://urlkai.com/api/channels?limit=2&page=1`

API 経由でチャネルを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/channels?limit=2&page=1"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        "channels": [
            {
                "id": 1,
                "名前": "チャンネル1",
                "description": "チャンネル1の説明",
                "カラー": "#000000",
                "starred": true
            },
            {
                "id": 2,
                "名前": "チャンネル2",
                "description": "チャンネル2の説明",
                "color": "#FF0000",
                "starred": 偽
            }
        ]
    }
}
```

###### チャンネルアイテムの一覧表示

取得  `https://urlkai.com/api/channel/:id?limit=1&page=1`

API を介して選択したチャネルのアイテムを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        "アイテム": [
            {
                "タイプ": "リンク",
                "id": 1,
                "title": "私のサンプルリンク",
                "preview": "https:\/\/google.com",
                "リンク": "https:\/\/urlkai.com\/google",
                「日付」: 「2022-05-12」
            },
            {
                "タイプ": "バイオ",
                "id": 1,
                "title": "私のサンプルバイオ",
                "preview": "https:\/\/urlkai.com\/mybio",
                "リンク": "https:\/\/urlkai.com\/mybio",
                "日付": "2022-06-01"
            }
        ]
    }
}
```

###### チャネルの作成

投稿  `https://urlkai.com/api/channel/add`

チャネルは、このエンドポイントを使用して追加できます。

| **パラメーター** | **形容** |
| --- | --- |
| 名前 | (必須)チャンネル名 |
| 形容 | (オプション)チャネルの説明 |
| 色 | (オプション)チャンネルバッジの色(HEX) |
| 主演 | (オプション)チャンネルにスターを付けるかどうか(trueまたはfalse) |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "New Channel",
	    "description": "my new channel",
	    "color": "#000000",
	    "starred": true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
import requests
url = "https://urlkai.com/api/channel/add"
payload = {
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)
```

```
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "error": 0,
    "id": 3,
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}
```

###### チャネルへのアイテムの割り当て

投稿  `https://urlkai.com/api/channel/:channelid/assign/:type/:itemid`

アイテムは、チャネルID、アイテムタイプ(リンク、バイオ、またはqr)、およびアイテムIDを使用してリクエストを送信することにより、任意のチャネルに割り当てることができます。

| **パラメーター** | **形容** |
| --- | --- |
| :チャンネルID | (必須)チャネルID |
| ：種類 | (必須)リンクまたはバイオまたはQR |
| :アイテムID | (必須)アイテムID |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "POST"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '投稿',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "アイテムはチャネルに正常に追加されました。"
}
```

###### 更新チャネル

置く  `https://urlkai.com/api/channel/:id/update`

チャネルを更新するには、PUTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 名前 | (オプション)チャンネル名 |
| 形容 | (オプション)チャネルの説明 |
| 色 | (オプション)チャンネルバッジの色(HEX) |
| 主演 | (オプション)チャンネルにスターを付けるかどうか(trueまたはfalse) |

cURL
PHP
Node.js
Python
C#

```
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "name": "アクメコーポレーション",
    "description": "Acme Corpのアイテムのチャンネル",
    "color": "#FFFFFF",
    "starred": 偽
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "PUT"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "name": "アクメコーポレーション",
	    "description": "Acme Corpのアイテムのチャンネル",
	    "color": "#FFFFFF",
	    "starred": 偽
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '置く',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "name": "アクメコーポレーション",
    "description": "Acme Corpのアイテムのチャンネル",
    "color": "#FFFFFF",
    "starred": 偽
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/channel/:id/update"
ペイロード = {
    "name": "アクメコーポレーション",
    "description": "Acme Corpのアイテムのチャンネル",
    "color": "#FFFFFF",
    "starred": 偽
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "name": "アクメコーポレーション",
    "description": "Acme Corpのアイテムのチャンネル",
    "color": "#FFFFFF",
    "starred": 偽
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "チャネルが正常に更新されました。"
}
```

###### チャネルの削除

削除  `https://urlkai.com/api/channel/:id/delete`

チャネルを削除するには、DELETE リクエストを送信する必要があります。すべてのアイテムも割り当て解除されます。

cURL
PHP
Node.js
Python
C#

```
curl --location --request 削除 'https://urlkai.com/api/channel/:id/delete' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "削除",
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '削除',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/channel/:id/delete"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("削除", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "チャンネルは正常に削除されました。"
}
```

---

#### カスタムスプラッシュ - Open in ChatGPT - Open in Claude

###### カスタムスプラッシュのリスト

取得  `https://urlkai.com/api/splash?limit=2&page=1`

API を介してカスタム スプラッシュ ページを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/splash?limit=2&page=1"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        "スプラッシュ": [
            {
                "id": 1,
                "name": "製品1プロモーション",
                "日付": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "製品2プロモーション",
                "日時": "2020-11-10 18:10:00"
            }
        ]
    }
}
```

---

#### ファイル - Open in ChatGPT - Open in Claude

###### リストファイル

取得  `https://urlkai.com/api/files?limit=2&page=1`

すべてのファイルを手に入れろ。名前で検索することもできます。

| **パラメーター** | **形容** |
| --- | --- |
| 名前 | (任意)ファイル名で検索 |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/files?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/files?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
import requests
url = "https://urlkai.com/api/files?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)
```

```
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/qnxBU",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/dIoBa",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/zSaaB",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
```

###### ファイルをアップロードする

投稿  `https://urlkai.com/api/files/upload/:filename?name=My+File`

ファイルをアップロードするには、バイナリデータを投稿本体として送信します。URLに:filenameではなく拡張子を含むファイル名(例:brandkit.zip)を送る必要があります。以下のパラメータを送信することでオプションを設定できます。

| **パラメーター** | **形容** |
| --- | --- |
| 名前 | (任意)ファイル名 |
| 習慣 | (オプション)ランダムエイリアスの代わりにカスタムエイリアス。 |
| ドメイン | (オプション)カスタムドメイン |
| パスワード | (オプション)パスワード保護 |
| 有効 期限 | (任意)ダウンロード例の有効期限は2021年9月28日です |
| MaxDownloads | (任意)最大ダウンロード数 |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/files/upload/:filename?name=My+File",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '"BINARY DATA"',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/files/upload/:filename?name=My+File',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify("BINARY DATA"),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
import requests
url = "https://urlkai.com/api/files/upload/:filename?name=My+File"
payload = "BINARY DATA"
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)
```

```
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/files/upload/:filename?name=My+File");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent(""BINARY DATA"", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/oaIBi"
}
```

---

#### リンクス - Open in ChatGPT - Open in Claude

###### リンクを一覧表示する

取得  `https://urlkai.com/api/urls?limit=2&page=1o=date`

API 経由でリンクを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
| 命令 | (オプション)日付間でデータを並べ替えるか、 |
| 短い | (オプション)短縮URLを使用して検索します。short パラメータを使用すると、他のすべてのパラメータは無視され、一致する場合は Single Link レスポンスが返されることに注意してください。 |
| q | (オプション)キーワードを使用してリンクを検索する |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/urls?limit=2&page=1o=date' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/urls?limit=2&page=1o=date"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/urls?limit=2&page=1o=date',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/urls?limit=2&page=1o=date"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/urls?limit=2&page=1o=date");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        "URLs": [
            {
                "id": 2,
                "エイリアス": "グーグル",
                "shorturl": "https:\/\/urlkai.com\/google",
                "longurl": "https:\/\/google.com",
                「クリック数」:0、
                "title": "グーグル",
                "説明": "",
                "日付": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "エイリアス": "googlecanada",
                "shorturl": "https:\/\/urlkai.com\/GoogleCanada",
                "longurl": "https:\/\/google.ca",
                「クリック数」:0、
                "title": "Googleカナダ",
                "説明": "",
                "日付": "2020-11-10 18:00:25"
            }
        ]
    }
}
```

###### 単一のリンクを取得する

取得  `https://urlkai.com/api/url/:id`

API を介して 1 つのリンクの詳細を取得するには、このエンドポイントを使用できます。

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/url/:id' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/url/:id"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/url/:id',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/url/:id"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/url/:id");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "id": 1,
    "詳細": {
        "id": 1,
        "shorturl": "https:\/\/urlkai.com\/GoogleCanada",
        "longurl": "https:\/\/google.com",
        "title": "グーグル",
        "説明": "",
        "場所": {
            "カナダ": "https:\/\/google.ca",
            "United States": "https:\/\/google.us"
        },
        "デバイス": {
            "iphone": "https:\/\/google.com",
            "android": "https:\/\/google.com"
        },
        "有効期限": null,
        "日付": "2020-11-10 18:01:43"
    },
    "データ": {
        「クリック数」:0、
        "uniqueClicks":0、
        "topCountries": 0,
        "topReferrers": 0,
        "topBrowsers": 0,
        "topOs": 0,
        "ソーシャルカウント": {
            "フェイスブック":0、
            "さえずり":0、
            "Google": 0
        }
    }
}
```

###### リンクを短縮する

投稿  `https://urlkai.com/api/url/add`

リンクを短縮するには、POSTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 関連URL | (必須)短縮する長いURL。 |
| 習慣 | (オプション)ランダムエイリアスの代わりにカスタムエイリアス。 |
| 種類 | (オプション)リダイレクトタイプ[ダイレクト、フレーム、スプラッシュ]のみ *身分証明書* カスタムスプラッシュページの場合、または *オーバーレイ ID* CTAページの場合 |
| パスワード | (オプション)パスワード保護 |
| ドメイン | (オプション)カスタムドメイン |
| 有効 期限 | (オプション)リンク例の有効期限 2021-09-28 23:11:16 |
| ジオターゲット | (オプション)地域ターゲティングデータ |
| デバイスターゲット | (オプション)デバイスのターゲティング データ |
| 言語ターゲット | (オプション)言語ターゲティングデータ |
| メタタイトル | (オプション)メタタイトル |
| メタディスクリプション | (オプション)メタディスクリプション |
| メタイメージ | (オプション)jpgまたはpng画像へのリンク |
| 形容 | (オプション)注または説明 |
| ピクセル | (オプション)ピクセル ID の配列 |
| チャンネル | (オプション)チャネルID |
| キャンペーン | (オプション)キャンペーンID |
| ディープリンク | (任意)アプリストアリンクを含むオブジェクト。これを使う際は、デバイスのターゲティング設定も行うことが重要です。(新)パラメータ「auto」をtrueに設定すれば、提供された長いリンクからディープリンクを自動的に生成できます。 |
| 地位 | (オプション) *公共* 又は *private (デフォルト)* |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/url/add' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "url": "https:\/\/google.com",
    "ステータス": "プライベート",
    "カスタム": "グーグル",
    "password": "mypass"、
    "有効期限": "2020-11-11 12:00:00",
    "タイプ": "スプラッシュ",
    "metatitle": "Googleではない",
    "metadescription": "Googleの説明ではありません",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "Facebookの場合",
    "ピクセル": [
        1,
        2,
        3,
        4
    ],
    "チャンネル": 1,
    「キャンペーン」:1、
    "ディープリンク": {
        "auto": true,
        "アップル": "https:\/\/apps.apple.com<[>\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "ジオターゲット": [
        {
            "location": "カナダ",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "アメリカ合衆国",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "デバイス": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "デバイス": "アンドロイド",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr"、
            "link": "https:\/\/google.ca"
        }
    ],
    "パラメータ": [
        {
            "名前": "aff",
            "値": "3"
        },
        {
            "デバイス": "gtm_source",
            "link": "api" (リンク": "api"
        }
    ]
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/url/add"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "POST"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "url": "https:\/\/google.com",
	    "ステータス": "プライベート",
	    "カスタム": "グーグル",
	    "password": "mypass"、
	    "有効期限": "2020-11-11 12:00:00",
	    "タイプ": "スプラッシュ",
	    "metatitle": "Googleではない",
	    "metadescription": "Googleの説明ではありません",
	    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
	    "description": "Facebookの場合",
	    "ピクセル": [
	        1,
	        2,
	        3,
	        4
	    ],
	    "チャンネル": 1,
	    「キャンペーン」:1、
	    "ディープリンク": {
	        "auto": true,
	        "アップル": "https:\/\/apps.apple.com<[>\/us\/app\/google\/id284815942",
	        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
	    },
	    "ジオターゲット": [
	        {
	            "location": "カナダ",
	            "link": "https:\/\/google.ca"
	        },
	        {
	            "location": "アメリカ合衆国",
	            "link": "https:\/\/google.us"
	        }
	    ],
	    "devicetarget": [
	        {
	            "デバイス": "iPhone",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "デバイス": "アンドロイド",
	            "link": "https:\/\/google.com"
	        }
	    ],
	    "languagetarget": [
	        {
	            "language": "en",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "language": "fr"、
	            "link": "https:\/\/google.ca"
	        }
	    ],
	    "パラメータ": [
	        {
	            "名前": "aff",
	            "値": "3"
	        },
	        {
	            "デバイス": "gtm_source",
	            "link": "api" (リンク": "api"
	        }
	    ]
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '投稿',
    'url': 'https://urlkai.com/api/url/add',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "url": "https:\/\/google.com",
    "ステータス": "プライベート",
    "カスタム": "グーグル",
    "password": "mypass"、
    "有効期限": "2020-11-11 12:00:00",
    "タイプ": "スプラッシュ",
    "metatitle": "Googleではない",
    "metadescription": "Googleの説明ではありません",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "Facebookの場合",
    "ピクセル": [
        1,
        2,
        3,
        4
    ],
    "チャンネル": 1,
    「キャンペーン」:1、
    "ディープリンク": {
        "auto": true,
        "アップル": "https:\/\/apps.apple.com<[>\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "ジオターゲット": [
        {
            "location": "カナダ",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "アメリカ合衆国",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "デバイス": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "デバイス": "アンドロイド",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr"、
            "link": "https:\/\/google.ca"
        }
    ],
    "パラメータ": [
        {
            "名前": "aff",
            "値": "3"
        },
        {
            "デバイス": "gtm_source",
            "link": "api" (リンク": "api"
        }
    ]
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/url/add"
ペイロード = {
    "url": "https://google.com",
    "ステータス": "プライベート",
    "カスタム": "グーグル",
    "password": "mypass"、
    "有効期限": "2020-11-11 12:00:00",
    "タイプ": "スプラッシュ",
    "metatitle": "Googleではない",
    "metadescription": "Googleの説明ではありません",
    "メタイメージ": "https://www.mozilla.org/media/protocol/img/logos/firefox/browser/og.4ad05d4125a5.png",
    "description": "Facebookの場合",
    "ピクセル": [
        1,
        2,
        3,
        4
    ],
    "チャンネル": 1,
    「キャンペーン」:1、
    "ディープリンク": {
        "auto": true,
        "りんご": "https://apps.apple.com/us/app/google/id284815942",
        "google": "https://play.google.com/store/apps/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=米国"
    },
    "ジオターゲット": [
        {
            "location": "カナダ",
            "link": "https://google.ca"
        },
        {
            "location": "アメリカ合衆国",
            "link": "https://google.us"
        }
    ],
    "devicetarget": [
        {
            "デバイス": "iPhone",
            "link": "https://google.com"
        },
        {
            "デバイス": "アンドロイド",
            "link": "https://google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https://google.com"
        },
        {
            "language": "fr"、
            "link": "https://google.ca"
        }
    ],
    "パラメータ": [
        {
            "名前": "aff",
            "値": "3"
        },
        {
            "デバイス": "gtm_source",
            "link": "api" (リンク": "api"
        }
    ]
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/url/add");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "url": "https:\/\/google.com",
    "ステータス": "プライベート",
    "カスタム": "グーグル",
    "password": "mypass"、
    "有効期限": "2020-11-11 12:00:00",
    "タイプ": "スプラッシュ",
    "metatitle": "Googleではない",
    "metadescription": "Googleの説明ではありません",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "Facebookの場合",
    "ピクセル": [
        1,
        2,
        3,
        4
    ],
    "チャンネル": 1,
    「キャンペーン」:1、
    "ディープリンク": {
        "auto": true,
        "アップル": "https:\/\/apps.apple.com<[>\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "ジオターゲット": [
        {
            "location": "カナダ",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "アメリカ合衆国",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "デバイス": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "デバイス": "アンドロイド",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr"、
            "link": "https:\/\/google.ca"
        }
    ],
    "パラメータ": [
        {
            "名前": "aff",
            "値": "3"
        },
        {
            "デバイス": "gtm_source",
            "link": "api" (リンク": "api"
        }
    ]
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "id": 3,
    "shorturl": "https:\/\/urlkai.com\/google"
}
```

###### 更新リンク

置く  `https://urlkai.com/api/url/:id/update`

リンクを更新するには、PUTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 関連URL | (必須)短縮する長いURL。 |
| 習慣 | (オプション)ランダムエイリアスの代わりにカスタムエイリアス。 |
| 種類 | (オプション)リダイレクトの種類 [ダイレクト、フレーム、スプラッシュ] |
| パスワード | (オプション)パスワード保護 |
| ドメイン | (オプション)カスタムドメイン |
| 有効 期限 | (オプション)リンク例の有効期限 2021-09-28 23:11:16 |
| ジオターゲット | (オプション)地域ターゲティングデータ |
| デバイスターゲット | (オプション)デバイスのターゲティング データ |
| 言語ターゲット | (オプション)言語ターゲティングデータ |
| メタタイトル | (オプション)メタタイトル |
| メタディスクリプション | (オプション)メタディスクリプション |
| メタイメージ | (オプション)jpgまたはpng画像へのリンク |
| ピクセル | (オプション)ピクセル ID の配列 |
| チャンネル | (オプション)チャネルID |
| キャンペーン | (オプション)キャンペーンID |
| ディープリンク | (オプション)アプリストアのリンクを含むオブジェクト。これを使用する場合は、デバイスのターゲティングも設定することが重要です。 |

cURL
PHP
Node.js
Python
C#

```
curl --location --request PUT 'https://urlkai.com/api/url/:id/update' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "url": "https:\/\/google.com",
    "カスタム": "グーグル",
    "password": "mypass"、
    "有効期限": "2020-11-11 12:00:00",
    "タイプ": "スプラッシュ",
    "ピクセル": [
        1,
        2,
        3,
        4
    ],
    "チャンネル": 1,
    "ディープリンク": {
        "アップル": "https:\/\/apps.apple.com<[>\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "ジオターゲット": [
        {
            "location": "カナダ",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "アメリカ合衆国",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "デバイス": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "デバイス": "アンドロイド",
            "link": "https:\/\/google.com"
        }
    ],
    "パラメータ": [
        {
            "名前": "aff",
            "値": "3"
        },
        {
            "デバイス": "gtm_source",
            "link": "api" (リンク": "api"
        }
    ]
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/url/:id/update"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "PUT"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "url": "https:\/\/google.com",
	    "カスタム": "グーグル",
	    "password": "mypass"、
	    "有効期限": "2020-11-11 12:00:00",
	    "タイプ": "スプラッシュ",
	    "ピクセル": [
	        1,
	        2,
	        3,
	        4
	    ],
	    "チャンネル": 1,
	    "ディープリンク": {
	        "アップル": "https:\/\/apps.apple.com<[>\/us\/app\/google\/id284815942",
	        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
	    },
	    "ジオターゲット": [
	        {
	            "location": "カナダ",
	            "link": "https:\/\/google.ca"
	        },
	        {
	            "location": "アメリカ合衆国",
	            "link": "https:\/\/google.us"
	        }
	    ],
	    "devicetarget": [
	        {
	            "デバイス": "iPhone",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "デバイス": "アンドロイド",
	            "link": "https:\/\/google.com"
	        }
	    ],
	    "パラメータ": [
	        {
	            "名前": "aff",
	            "値": "3"
	        },
	        {
	            "デバイス": "gtm_source",
	            "link": "api" (リンク": "api"
	        }
	    ]
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '置く',
    'url': 'https://urlkai.com/api/url/:id/update',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "url": "https:\/\/google.com",
    "カスタム": "グーグル",
    "password": "mypass"、
    "有効期限": "2020-11-11 12:00:00",
    "タイプ": "スプラッシュ",
    "ピクセル": [
        1,
        2,
        3,
        4
    ],
    "チャンネル": 1,
    "ディープリンク": {
        "アップル": "https:\/\/apps.apple.com<[>\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "ジオターゲット": [
        {
            "location": "カナダ",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "アメリカ合衆国",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "デバイス": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "デバイス": "アンドロイド",
            "link": "https:\/\/google.com"
        }
    ],
    "パラメータ": [
        {
            "名前": "aff",
            "値": "3"
        },
        {
            "デバイス": "gtm_source",
            "link": "api" (リンク": "api"
        }
    ]
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/url/:id/update"
ペイロード = {
    "url": "https://google.com",
    "カスタム": "グーグル",
    "password": "mypass"、
    "有効期限": "2020-11-11 12:00:00",
    "タイプ": "スプラッシュ",
    "ピクセル": [
        1,
        2,
        3,
        4
    ],
    "チャンネル": 1,
    "ディープリンク": {
        "りんご": "https://apps.apple.com/us/app/google/id284815942",
        "google": "https://play.google.com/store/apps/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=米国"
    },
    "ジオターゲット": [
        {
            "location": "カナダ",
            "link": "https://google.ca"
        },
        {
            "location": "アメリカ合衆国",
            "link": "https://google.us"
        }
    ],
    "devicetarget": [
        {
            "デバイス": "iPhone",
            "link": "https://google.com"
        },
        {
            "デバイス": "アンドロイド",
            "link": "https://google.com"
        }
    ],
    "パラメータ": [
        {
            "名前": "aff",
            "値": "3"
        },
        {
            "デバイス": "gtm_source",
            "link": "api" (リンク": "api"
        }
    ]
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/url/:id/update");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "url": "https:\/\/google.com",
    "カスタム": "グーグル",
    "password": "mypass"、
    "有効期限": "2020-11-11 12:00:00",
    "タイプ": "スプラッシュ",
    "ピクセル": [
        1,
        2,
        3,
        4
    ],
    "チャンネル": 1,
    "ディープリンク": {
        "アップル": "https:\/\/apps.apple.com<[>\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "ジオターゲット": [
        {
            "location": "カナダ",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "アメリカ合衆国",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "デバイス": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "デバイス": "アンドロイド",
            "link": "https:\/\/google.com"
        }
    ],
    "パラメータ": [
        {
            "名前": "aff",
            "値": "3"
        },
        {
            "デバイス": "gtm_source",
            "link": "api" (リンク": "api"
        }
    ]
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "id": 3,
    "short": "https:\/\/urlkai.com\/google"
}
```

###### リンクの削除

削除  `https://urlkai.com/api/url/:id/delete`

リンクを削除するには、DELETE リクエストを送信する必要があります。

cURL
PHP
Node.js
Python
C#

```
curl --location --request DELETE 'https://urlkai.com/api/url/:id/delete' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/url/:id/delete"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "削除",
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '削除',
    'url': 'https://urlkai.com/api/url/:id/delete',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/url/:id/delete"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("削除", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/url/:id/delete");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "リンクは正常に削除されました"
}
```

---

#### ピクセル - Open in ChatGPT - Open in Claude

###### ピクセルのリスト

取得  `https://urlkai.com/api/pixels?limit=2&page=1`

APIを介してピクセルコードを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/pixels?limit=2&page=1"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        "ピクセル": [
            {
                "id": 1,
                "タイプ": "gtmpixel",
                "name": "GTMピクセル",
                "タグ": "GA-123456789",
                "日付": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "タイプ": "ツイッターピクセル",
                "名前": "Twitterピクセル",
                "タグ": "1234567",
                "日時": "2020-11-10 18:10:00"
            }
        ]
    }
}
```

###### ピクセルを作成する

投稿  `https://urlkai.com/api/pixel/add`

ピクセルは、このエンドポイントを使用して作成できます。ピクセルタイプとタグを送信する必要があります。

| **パラメーター** | **形容** |
| --- | --- |
| 種類 | (必須) GTMPIXEL |ガピクセル |FBピクセル |アドワーズピクセル |LinkedInピクセル |ツイッターピクセル |アドロールピクセル |クオラピクセル |ピンタレスト |Bingの|スナップチャット |Redditの|TikTokの |
| 名前 | (必須)ピクセルのカスタム名 |
| 日 | (必須)ピクセルのタグ |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "タイプ": "gtmpixel",
    "name": "私のGTM",
    "tag": "GTM-ABCDE"
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "POST"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "タイプ": "gtmpixel",
	    "name": "私のGTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '投稿',
    'url': 'https://urlkai.com/api/pixel/add',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "タイプ": "gtmpixel",
    "name": "私のGTM",
    "tag": "GTM-ABCDE"
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/pixel/add"
ペイロード = {
    "タイプ": "gtmpixel",
    "name": "私のGTM",
    "tag": "GTM-ABCDE"
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "タイプ": "gtmpixel",
    "name": "私のGTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "id": 1
}
```

###### ピクセルを更新

置く  `https://urlkai.com/api/pixel/:id/update`

ピクセルを更新するには、PUTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 名前 | (オプション)ピクセルのカスタム名 |
| 日 | (必須)ピクセルのタグ |

cURL
PHP
Node.js
Python
C#

```
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "name": "私のGTM",
    "tag": "GTM-ABCDE"
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "PUT"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "name": "私のGTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '置く',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "name": "私のGTM",
    "tag": "GTM-ABCDE"
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/pixel/:id/update"
ペイロード = {
    "name": "私のGTM",
    "tag": "GTM-ABCDE"
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "name": "私のGTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "Pixel は正常に更新されました。"
}
```

###### ピクセルの削除

削除  `https://urlkai.com/api/pixel/:id/delete`

ピクセルを削除するには、DELETEリクエストを送信する必要があります。

cURL
PHP
Node.js
Python
C#

```
curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "削除",
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '削除',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/pixel/:id/delete"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("削除", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "ピクセルは正常に削除されました。"
}
```

---

#### QRコード - Open in ChatGPT - Open in Claude

###### QRコードを一覧表示する

取得  `https://urlkai.com/api/qr?limit=2&page=1`

APIを介してQRコードを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/qr?limit=2&page=1"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": "0",
    "データ": {
        "結果": 2,
        "perpage": 2,
        "現在のページ": 1,
        "nextpage": 1,
        "maxpage": 1,
        「qrs」: [
            {
                "id": 2,
                "リンク": "https:\/\/urlkai.com\/qr\/a2d5e",
                "スキャン":0、
                "名前": "Google",
                "日付": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "リンク": "https:\/\/urlkai.com\/qr\/b9edfe",
                「スキャン」:5、
                "name": "Googleカナダ",
                "日付": "2020-11-10 18:00:25"
            }
        ]
    }
}
```

###### QRコードを1つ取得

取得  `https://urlkai.com/api/qr/:id`

API を介して 1 つの QR コードの詳細を取得するには、このエンドポイントを使用できます。

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "GET"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '取得',
    'url': 'https://urlkai.com/api/qr/:id',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/qr/:id"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "詳細": {
        "id": 1,
        "リンク": "https:\/\/urlkai.com\/qr\/b9edfe",
        「スキャン」:5、
        "name": "Googleカナダ",
        "日付": "2020-11-10 18:00:25"
    },
    "データ": {
        「クリック数」:1、
        "uniqueClicks":1、
        "topCountries": {
            "不明": "1"
        },
        "topReferrers": {
            「直接、電子メール、その他」: 「1」
        },
        "topBrowsers": {
            「クローム」: 「1」
        },
        "topOs": {
            「Windows 10」:「1」
        },
        "ソーシャルカウント": {
            "フェイスブック":0、
            "さえずり":0、
            「インスタグラム」:0
        }
    }
}
```

###### QRコードを作成する

投稿  `https://urlkai.com/api/qr/add`

QRコードを作成するには、POSTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| 種類 | (必須) テキスト |vカード |リンク |Eメール |電話番号 |SMSの|Wi-Fi(無線LAN) |
| データ | (必須)QRコード内に埋め込むデータ。データは、タイプに応じて文字列または配列にすることができます |
| バックグラウンド | (オプション)RGBカラー(例:rgb(255,255,255) |
| 前景 | (オプション)RGB カラー (例: rgb(0,0,0)) |
| ロゴ | (オプション)ロゴへのパス:pngまたはjpg |
| 名前 | (オプション)QRコード名 |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "タイプ": "リンク",
    "データ": "https:\/\/google.com",
    "背景": "RGB(255,255,255)",
    "フォアグラウンド": "rgb(0,0,0)"、
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QRコードAPI"
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr/add"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "POST"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "タイプ": "リンク",
	    "データ": "https:\/\/google.com",
	    "背景": "RGB(255,255,255)",
	    "フォアグラウンド": "rgb(0,0,0)"、
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "QRコードAPI"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '投稿',
    'url': 'https://urlkai.com/api/qr/add',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "タイプ": "リンク",
    "データ": "https:\/\/google.com",
    "背景": "RGB(255,255,255)",
    "フォアグラウンド": "rgb(0,0,0)"、
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QRコードAPI"
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/qr/add"
ペイロード = {
    "タイプ": "リンク",
    "データ": "https://google.com",
    "背景": "RGB(255,255,255)",
    "フォアグラウンド": "rgb(0,0,0)"、
    "ロゴ": "https://site.com/logo.png",
    "name": "QRコードAPI"
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "タイプ": "リンク",
    "データ": "https:\/\/google.com",
    "背景": "RGB(255,255,255)",
    "フォアグラウンド": "rgb(0,0,0)"、
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QRコードAPI"
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "id": 3,
    "リンク": "https:\/\/urlkai.com\/qr\/a58f79"
}
```

###### QRコードの更新

置く  `https://urlkai.com/api/qr/:id/update`

QRコードを更新するには、PUTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。

| **パラメーター** | **形容** |
| --- | --- |
| データ | (必須)QRコード内に埋め込むデータ。データは、タイプに応じて文字列または配列にすることができます |
| バックグラウンド | (オプション)RGBカラー(例:rgb(255,255,255) |
| 前景 | (オプション)RGB カラー (例: rgb(0,0,0)) |
| ロゴ | (オプション)ロゴへのパス:pngまたはjpg |

cURL
PHP
Node.js
Python
C#

```
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
    "タイプ": "リンク",
    "データ": "https:\/\/google.com",
    "背景": "RGB(255,255,255)",
    "フォアグラウンド": "rgb(0,0,0)"、
    "logo": "https:\/\/site.com\/logo.png"
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "PUT"、
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    "タイプ": "リンク",
	    "データ": "https:\/\/google.com",
	    "背景": "RGB(255,255,255)",
	    "フォアグラウンド": "rgb(0,0,0)"、
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '置く',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    ボディ: JSON.stringify({
    "タイプ": "リンク",
    "データ": "https:\/\/google.com",
    "背景": "RGB(255,255,255)",
    "フォアグラウンド": "rgb(0,0,0)"、
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/qr/:id/update"
ペイロード = {
    "タイプ": "リンク",
    "データ": "https://google.com",
    "背景": "RGB(255,255,255)",
    "フォアグラウンド": "rgb(0,0,0)"、
    "logo": "https://site.com/logo.png"
}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
    "タイプ": "リンク",
    "データ": "https:\/\/google.com",
    "背景": "RGB(255,255,255)",
    "フォアグラウンド": "rgb(0,0,0)"、
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "QRは正常に更新されました。"
}
```

###### QRコードを削除する

削除  `https://urlkai.com/api/qr/:id/delete`

QRコードを削除するには、DELETEリクエストを送信する必要があります。

cURL
PHP
Node.js
Python
C#

```
curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete"、
    CURLOPT_RETURNTRANSFER => true、
    CURLOPT_MAXREDIRS => 2、
    CURLOPT_TIMEOUT = > 10、
    CURLOPT_FOLLOWLOCATION => true、
    CURLOPT_CUSTOMREQUEST => "削除",
    CURLOPT_HTTPHEADER => [
        「認証:ベアラーYOURAPIKEY」、
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
エコー$response;
```

```
var request = require('request');
var オプション = {
    'メソッド': '削除',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'ヘッダー': {
        '認証': 'ベアラー YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(オプション, 関数 (エラー, レスポンス) {
    if (error) throw new エラー(error);
    console.log(response.body);
});
```

```
インポートリクエスト
url = "https://urlkai.com/api/qr/:id/delete"
ペイロード = {}
ヘッダー = {
    '認証': 'ベアラー YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("削除", url, headers=headers, json=ペイロード)
print(response.text)
```

```
var client = 新しいHttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync());
```

###### サーバーの応答

```
{
    "エラー": 0,
    "message": "QRコードが正常に削除されました。"
}
```