Uma chave de API é necessária para que as solicitações sejam processadas pelo sistema.Depois que um usuário se registra, uma chave de API é gerada automaticamente para esse usuário.A chave de API deve ser enviada com cada solicitação (veja o exemplo completo abaixo).Se a chave de API não for enviada ou tiver expirado, ocorrerá um erro.Certifique-se de manter sua chave de API em segredo para evitar abusos.
Para autenticar com o sistema de API, você precisa enviar sua chave de API como um token de autorização com cada solicitação.Você pode ver o código de exemplo abaixo.
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()); Nossa API tem um limitador de taxa para proteger contra picos de solicitações para maximizar sua estabilidade.Nosso limitador de taxa está limitado a 30 solicitações por 1 minuto.ご加入のプランによって料金が変更になる場合がありますので、予めご了承ください。
Vários cabeçalhos serão enviados juntamente com a resposta e estes podem ser examinados para determinar várias informações sobre a solicitação.
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Todas as respostas da API são retornadas no formato JSON por padrão.Para converter isso em dados utilizáveis, a função apropriada precisará ser usada de acordo com o idioma.Em PHP, a função json_decode() pode ser usada para converter os dados em um objeto (padrão) ou um array (defina o segundo parâmetro como true).É muito importante verificar a chave de erro, pois ela fornece informações sobre se houve ou não um erro.Você também pode verificar o código do cabeçalho.
{
"error": 1,
"message": "An error occurred"
}https://urlkai.com/api/account
アカウントに関する情報を取得するには、このエンドポイントにリクエストを送信すると、アカウントのデータが返されます。
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 --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": "アカウントが正常に更新されました。"
} https://urlkai.com/api/campaigns?limit=2&page=1
API経由でキャンペーンを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
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
キャンペーンは、このエンドポイントを使用して追加できます。
| パラメトロ | Descrição |
|---|---|
| 名前 | (オプション)キャンペーン名 |
| 蛞蝓 | (オプション)ローテータースラッグ |
| 公共 | (オプション)アクセス |
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
"name": "新しいキャンペーン",
"スラッグ": "新しいキャンペーン",
"public": 真
}' $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 => [
「認証:ベアラーYOURAPIKEY」、
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "新しいキャンペーン",
"スラッグ": "新しいキャンペーン",
"public": 真
}',
));
$response = curl_exec($curl);
curl_close($curl);
エコー$response; var request = require('request');
var オプション = {
'メソッド': '投稿',
'url': 'https://urlkai.com/api/campaign/add',
'ヘッダー': {
'認証': 'ベアラー YOURAPIKEY',
'Content-Type': 'application/json'
},
ボディ: JSON.stringify({
"name": "新しいキャンペーン",
"スラッグ": "新しいキャンペーン",
"public": 真
}),
};
request(オプション, 関数 (エラー, レスポンス) {
if (error) throw new エラー(error);
console.log(response.body);
}); インポートリクエスト
url = "https://urlkai.com/api/campaign/add"
ペイロード = {
"name": "新しいキャンペーン",
"スラッグ": "新しいキャンペーン",
"public": 真
}
ヘッダー = {
'認証': 'ベアラー 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/add");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
"name": "新しいキャンペーン",
"スラッグ": "新しいキャンペーン",
"public": 真
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync()); {
"エラー": 0,
"id": 3,
"domain": "新キャンペーン",
"public": true です。
"rotator": "https:\/\/domain.com\/r\/new-campaign",
"リスト": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} https://urlkai.com/api/campaign/:campaignid/assign/:linkid
短縮リンクは、このエンドポイントを使用してキャンペーンに割り当てることができます。エンドポイントには、キャンペーン ID と短縮リンク ID が必要です。
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で有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 名前 | (必須)キャンペーン名 |
| 蛞蝓 | (オプション)ローテータースラッグ |
| 公共 | (オプション)アクセス |
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 --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": "キャンペーンは正常に削除されました。"
} https://urlkai.com/api/channels?limit=2&page=1
API 経由でチャネルを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
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 を介して選択したチャネルのアイテムを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
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
チャネルは、このエンドポイントを使用して追加できます。
| パラメトロ | Descrição |
|---|---|
| 名前 | (必須)チャンネル名 |
| 形容 | (オプション)チャネルの説明 |
| 色 | (オプション)チャンネルバッジの色(HEX) |
| 主演 | (オプション)チャンネルにスターを付けるかどうか(trueまたはfalse) |
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header '認証: ベアラー YOURAPIKEY' \
--header 'コンテンツタイプ: application/json' \
--data-raw '{
"name": "新しいチャンネル",
"description": "私の新しいチャンネル",
"カラー": "#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 => [
「認証:ベアラーYOURAPIKEY」、
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "新しいチャンネル",
"description": "私の新しいチャンネル",
"カラー": "#000000",
"starred": true
}',
));
$response = curl_exec($curl);
curl_close($curl);
エコー$response; var request = require('request');
var オプション = {
'メソッド': '投稿',
'url': 'https://urlkai.com/api/channel/add',
'ヘッダー': {
'認証': 'ベアラー YOURAPIKEY',
'Content-Type': 'application/json'
},
ボディ: JSON.stringify({
"name": "新しいチャンネル",
"description": "私の新しいチャンネル",
"カラー": "#000000",
"starred": true
}),
};
request(オプション, 関数 (エラー, レスポンス) {
if (error) throw new エラー(error);
console.log(response.body);
}); インポートリクエスト
url = "https://urlkai.com/api/channel/add"
ペイロード = {
"name": "新しいチャンネル",
"description": "私の新しいチャンネル",
"カラー": "#000000",
"starred": true
}
ヘッダー = {
'認証': 'ベアラー 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/add");
依頼。Headers.Add("認証", "ベアラーYOURAPIKEY");
var content = new StringContent("{
"name": "新しいチャンネル",
"description": "私の新しいチャンネル",
"カラー": "#000000",
"starred": true
}", System.Text.Encoding.UTF8, "application/json");
依頼。コンテンツ = コンテンツ;
var response = await client.SendAsync(リクエスト);
応答。EnsureSuccessStatusCode();
Console.WriteLine(応答を待機します。Content.ReadAsStringAsync()); {
"エラー": 0,
"id": 3,
"name": "新しいチャンネル",
"description": "私の新しいチャンネル",
"カラー": "#000000",
"starred": true
} https://urlkai.com/api/channel/:channelid/assign/:type/:itemid
アイテムは、チャネルID、アイテムタイプ(リンク、バイオ、またはqr)、およびアイテムIDを使用してリクエストを送信することにより、任意のチャネルに割り当てることができます。
| パラメトロ | Descrição |
|---|---|
| :チャンネルID | (必須)チャネルID |
| ：種類 | (必須)リンクまたはバイオまたはQR |
| :アイテムID | (必須)アイテムID |
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で有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 名前 | (オプション)チャンネル名 |
| 形容 | (オプション)チャネルの説明 |
| 色 | (オプション)チャンネルバッジの色(HEX) |
| 主演 | (オプション)チャンネルにスターを付けるかどうか(trueまたはfalse) |
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 --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": "チャンネルは正常に削除されました。"
} https://urlkai.com/api/qr?limit=2&page=1
APIを介してQRコードを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
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"
}
]
}
} https://urlkai.com/api/qr/:id
API を介して 1 つの QR コードの詳細を取得するには、このエンドポイントを使用できます。
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
}
}
} https://urlkai.com/api/qr/add
QRコードを作成するには、POSTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 種類 | (必須) テキスト |vカード |リンク |Eメール |電話番号 |SMSの|Wi-Fi(無線LAN) |
| データ | (必須)QRコード内に埋め込むデータ。データは、タイプに応じて文字列または配列にすることができます |
| バックグラウンド | (オプション)RGBカラー(例:rgb(255,255,255) |
| 前景 | (オプション)RGB カラー (例: rgb(0,0,0)) |
| ロゴ | (オプション)ロゴへのパス:pngまたはjpg |
| 名前 | (オプション)QRコード名 |
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"
} https://urlkai.com/api/qr/:id/update
QRコードを更新するには、PUTリクエストを介してJSONで有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| データ | (必須)QRコード内に埋め込むデータ。データは、タイプに応じて文字列または配列にすることができます |
| バックグラウンド | (オプション)RGBカラー(例:rgb(255,255,255) |
| 前景 | (オプション)RGB カラー (例: rgb(0,0,0)) |
| ロゴ | (オプション)ロゴへのパス:pngまたはjpg |
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は正常に更新されました。"
} https://urlkai.com/api/qr/:id/delete
QRコードを削除するには、DELETEリクエストを送信する必要があります。
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コードが正常に削除されました。"
} https://urlkai.com/api/domains?limit=2&page=1
API を介してブランド化されたドメインを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
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
ドメインは、このエンドポイントを使用して追加できます。ドメインがサーバーを正しく指していることを確認してください。
| パラメトロ | Descrição |
|---|---|
| ドメイン | (必須)httpまたはhttpsを含むブランドドメイン |
| リダイレクトルート | (オプション)誰かがあなたのドメインにアクセスしたときのルートリダイレクト |
| リダイレクト404 | (オプション)カスタム 404 リダイレクト |
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で有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| リダイレクトルート | (オプション)誰かがあなたのドメインにアクセスしたときのルートリダイレクト |
| リダイレクト404 | (オプション)カスタム 404 リダイレクト |
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 --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": "ドメインは正常に削除されました。"
} https://urlkai.com/api/urls?limit=2&page=1o=date
API 経由でリンクを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
| 命令 | (オプション)日付間でデータを並べ替えるか、 |
| 短い | (オプション)短縮URLを使用して検索します。short パラメータを使用すると、他のすべてのパラメータは無視され、一致する場合は Single Link レスポンスが返されることに注意してください。 |
| q | (オプション)キーワードを使用してリンクを検索する |
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 --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で有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 関連URL | (必須)短縮する長いURL。 |
| 習慣 | (オプション)ランダムエイリアスの代わりにカスタムエイリアス。 |
| 種類 | (オプション)リダイレクトタイプ[ダイレクト、フレーム、スプラッシュ]のみ 身分証明書 カスタムスプラッシュページの場合、または オーバーレイ ID CTAページの場合 |
| パスワード | (オプション)パスワード保護 |
| ドメイン | (オプション)カスタムドメイン |
| 有効 期限 | (オプション)リンク例の有効期限 2021-09-28 23:11:16 |
| ジオターゲット | (オプション)地域ターゲティングデータ |
| デバイスターゲット | (オプション)デバイスのターゲティング データ |
| 言語ターゲット | (オプション)言語ターゲティングデータ |
| メタタイトル | (オプション)メタタイトル |
| メタディスクリプション | (オプション)メタディスクリプション |
| メタイメージ | (オプション)jpgまたはpng画像へのリンク |
| 形容 | (オプション)注または説明 |
| ピクセル | (オプション)ピクセル ID の配列 |
| チャンネル | (オプション)チャネルID |
| キャンペーン | (オプション)キャンペーンID |
| ディープリンク | (オプション)アプリストアのリンクを含むオブジェクト。これを使用する場合は、デバイスのターゲティングも設定することが重要です。(新規)パラメータ "auto" を true に設定して、提供された長いリンクからディープリンクを自動的に生成できるようになりました。 |
| 地位 | (オプション) 公共 又は private (デフォルト) |
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で有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 関連URL | (必須)短縮する長いURL。 |
| 習慣 | (オプション)ランダムエイリアスの代わりにカスタムエイリアス。 |
| 種類 | (オプション)リダイレクトの種類 [ダイレクト、フレーム、スプラッシュ] |
| パスワード | (オプション)パスワード保護 |
| ドメイン | (オプション)カスタムドメイン |
| 有効 期限 | (オプション)リンク例の有効期限 2021-09-28 23:11:16 |
| ジオターゲット | (オプション)地域ターゲティングデータ |
| デバイスターゲット | (オプション)デバイスのターゲティング データ |
| 言語ターゲット | (オプション)言語ターゲティングデータ |
| メタタイトル | (オプション)メタタイトル |
| メタディスクリプション | (オプション)メタディスクリプション |
| メタイメージ | (オプション)jpgまたはpng画像へのリンク |
| ピクセル | (オプション)ピクセル ID の配列 |
| チャンネル | (オプション)チャネルID |
| キャンペーン | (オプション)キャンペーンID |
| ディープリンク | (オプション)アプリストアのリンクを含むオブジェクト。これを使用する場合は、デバイスのターゲティングも設定することが重要です。 |
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 --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": "リンクは正常に削除されました"
} https://urlkai.com/api/pixels?limit=2&page=1
APIを介してピクセルコードを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
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
ピクセルは、このエンドポイントを使用して作成できます。ピクセルタイプとタグを送信する必要があります。
| パラメトロ | Descrição |
|---|---|
| 種類 | (必須) GTMPIXEL |ガピクセル |FBピクセル |アドワーズピクセル |LinkedInピクセル |ツイッターピクセル |アドロールピクセル |クオラピクセル |ピンタレスト |Bingの|スナップチャット |Redditの|TikTokの |
| 名前 | (必須)ピクセルのカスタム名 |
| 日 | (必須)ピクセルのタグ |
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で有効なデータを送信する必要があります。データは、以下に示すように、リクエストの生の本文として送信する必要があります。次の例は、送信できるすべてのパラメーターを示していますが、すべてを送信する必要はありません (詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 名前 | (オプション)ピクセルのカスタム名 |
| 日 | (必須)ピクセルのタグ |
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 --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": "ピクセルは正常に削除されました。"
} https://urlkai.com/api/overlay?limit=2&page=1
API を介して cta オーバーレイを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
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"
}
]
}
} https://urlkai.com/api/splash?limit=2&page=1
API を介してカスタム スプラッシュ ページを取得するには、このエンドポイントを使用できます。また、データをフィルタリングすることもできます(詳細については、表を参照してください)。
| パラメトロ | Descrição |
|---|---|
| 極限 | (オプション)ページあたりのデータ結果 |
| ページ | (オプション)現在のページリクエスト |
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"
}
]
}
}