È necessaria una chiave API affinché le richieste vengano elaborate dal sistema. Una volta che un utente si registra, viene generata automaticamente una chiave API per questo utente. La chiave API deve essere inviata con ogni richiesta (vedi esempio completo di seguito). Se la chiave API non viene inviata o è scaduta, si verificherà un errore. Assicurati di mantenere segreta la tua chiave API per prevenire abusi.
Per autenticarti con il sistema API, devi inviare la tua chiave API come token di autorizzazione con ogni richiesta. Puoi vedere il codice di esempio di seguito.
curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/account",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl); var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/account',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: ''
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/account"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); La nostra API ha un limitatore di velocità per salvaguardare da picchi di richieste per massimizzarne la stabilità. Il nostro limitatore di velocità è attualmente limitato a 30 richieste al 1 minuto. Observe que a tarifa pode mudar de acordo com o plano assinado.
Insieme alla risposta verranno inviate diverse intestazioni che possono essere esaminate per determinare varie informazioni sulla richiesta.
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Tutte le risposte API vengono restituite in formato JSON per impostazione predefinita. Per convertirli in dati utilizzabili, sarà necessario utilizzare la funzione appropriata in base alla lingua. In PHP, la funzione json_decode() può essere utilizzata per convertire i dati in un oggetto (predefinito) o in un array (impostare il secondo parametro su true). È molto importante controllare la chiave di errore in quanto fornisce informazioni sull'eventuale presenza di un errore. Puoi anche controllare il codice dell'intestazione.
{
"error": 1,
"message": "An error occurred"
}https://urlkai.com/api/account
Per ottenere informazioni sull'account, puoi inviare una richiesta a questo endpoint che restituirà i dati sull'account.
curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/account",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/account',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/account"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"dados": {
"id": 1,
"e-mail": " [email protegido] ",
"nome de usuário": "sampleuser",
"avatar": "https:\/\/domain.com\/content\/avatar.png",
"status": "pro",
"expira": "2022-11-15 15:00:00",
"registrado": "2020-11-10 18:01:43"
}
} https://urlkai.com/api/account/update
Per aggiornare le informazioni sull'account, puoi inviare una richiesta a questo endpoint che aggiornerà i dati sull'account.
curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"e-mail": " [email protegido] ",
"senha": "novasenha"
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/account/update",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "COLOCAR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"e-mail": " [email protegido] ",
"senha": "novasenha"
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'PUT',
'url': 'https://urlkai.com/api/account/update',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"e-mail": " [email protegido] ",
"senha": "novasenha"
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/account/update"
carga = {
"e-mail": " [email protegido] ",
"senha": "novasenha"
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("PUT", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var solicitação = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"e-mail": " [email protegido] ",
"senha": "novasenha"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "A conta foi atualizada com sucesso."
} https://urlkai.com/api/campaigns?limit=2&page=1
Para obter suas campanhas por meio da API, você pode usar esse endpoint. Você também pode filtrar dados (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"campanhas": [
{
"id": 1,
"name": "Exemplo de campanha",
"público": falso,
"rotator": false,
"lista": "https:\/\/domain.com\/u\/admin\/list-1"
},
{
"id": 2,
"domain": "Campanha do Facebook",
"público": verdadeiro,
"rotador": "https:\/\/domain.com\/r\/test",
"lista": "https:\/\/domain.com\/u\/admin\/test-2"
}
]
}
} https://urlkai.com/api/campaign/add
Uma campanha pode ser adicionada usando esse endpoint.
| Parametro | Descrizione |
|---|---|
| nome | (opcional) Nome da campanha |
| lesma | (opcional) Lesma Rotadora |
| público | (opcional) Acesso |
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"name": "Nova Campanha",
"slug": "nova campanha",
"público": verdadeiro
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/campaign/add",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Nova Campanha",
"slug": "nova campanha",
"público": verdadeiro
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/campaign/add',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"name": "Nova Campanha",
"slug": "nova campanha",
"público": verdadeiro
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/campaign/add"
carga = {
"name": "Nova Campanha",
"slug": "nova campanha",
"público": verdadeiro
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("POST", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Nova Campanha",
"slug": "nova campanha",
"público": verdadeiro
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 3,
"domain": "Nova Campanha",
"público": verdadeiro,
"rotator": "https:\/\/domain.com\/r\/new-campaign",
"lista": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} https://urlkai.com/api/campaign/:campaignid/assign/:linkid
Um link curto pode ser atribuído a uma campanha usando esse endpoint. O endpoint requer o ID da campanha e o ID do link curto.
curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("POST", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "Link adicionado com sucesso à campanha."
} https://urlkai.com/api/campaign/:id/update
Para atualizar uma campanha, você precisa enviar dados válidos em JSON por meio de uma solicitação PUT. Os dados devem ser enviados como o corpo bruto de sua solicitação, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| nome | (obrigatório) Nome da campanha |
| lesma | (opcional) Lesma Rotadora |
| público | (opcional) Acesso |
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"name": "Campanha do Twitter",
"slug": "campanha do twitter",
"público": verdadeiro
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "COLOCAR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Campanha do Twitter",
"slug": "campanha do twitter",
"público": verdadeiro
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'PUT',
'url': 'https://urlkai.com/api/campaign/:id/update',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"name": "Campanha do Twitter",
"slug": "campanha do twitter",
"público": verdadeiro
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/campaign/:id/update"
carga = {
"name": "Campanha do Twitter",
"slug": "campanha do twitter",
"público": verdadeiro
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("PUT", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Campanha do Twitter",
"slug": "campanha do twitter",
"público": verdadeiro
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 3,
"domain": "Campanha do Twitter",
"público": verdadeiro,
"rotator": "https:\/\/domain.com\/r\/twitter-campaign",
"lista": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} https://urlkai.com/api/campaign/:id/delete
Para excluir uma campanha, você precisa enviar uma solicitação DELETE.
curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "EXCLUIR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'DELETE',
'url': 'https://urlkai.com/api/campaign/:id/delete',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/campaign/:id/delete"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("DELETE", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "A campanha foi excluída com sucesso."
} https://urlkai.com/api/channels?limit=2&page=1
Para obter seus canais por meio da API, você pode usar esse endpoint. Você também pode filtrar dados (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/channels?limit=2&page=1',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/channels?limit=2&page=1"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"canais": [
{
"id": 1,
"name": "Canal 1",
"description": "Descrição do canal 1",
"cor": "#000000",
"Estrelado": Verdadeiro
},
{
"id": 2,
"name": "Canal 2",
"description": "Descrição do canal 2",
"cor": "#FF0000",
"estrelado": falso
}
]
}
} https://urlkai.com/api/channel/:id?limit=1&page=1
Para obter itens em um canal selecionado por meio da API, você pode usar esse endpoint. Você também pode filtrar dados (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"itens": [
{
"tipo": "links",
"id": 1,
"title": "Meu link de amostra",
"visualização": "https:\/\/google.com",
"link": "https:\/\/urlkai.com\/google",
"data": "2022-05-12"
},
{
"tipo": "bio",
"id": 1,
"title": "Minha biografia de amostra",
"visualização": "https:\/\/urlkai.com\/mybio",
"link": "https:\/\/urlkai.com\/mybio",
"data": "01/06/2022"
}
]
}
} https://urlkai.com/api/channel/add
Um canal pode ser adicionado usando esse ponto de extremidade.
| Parametro | Descrizione |
|---|---|
| nome | (obrigatório) Nome do canal |
| descrição | (opcional) Descrição do canal |
| Cor | (opcional) Cor do emblema do canal (HEX) |
| Estrelou | (opcional) Marcar o canal com estrela ou não (verdadeiro ou falso) |
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"name": "Novo Canal",
"description": "Meu novo canal",
"cor": "#000000",
"Estrelado": Verdadeiro
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/channel/add",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Novo Canal",
"description": "Meu novo canal",
"cor": "#000000",
"Estrelado": Verdadeiro
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/channel/add',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"name": "Novo Canal",
"description": "Meu novo canal",
"cor": "#000000",
"Estrelado": Verdadeiro
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/channel/add"
carga = {
"name": "Novo Canal",
"description": "Meu novo canal",
"cor": "#000000",
"Estrelado": Verdadeiro
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("POST", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Novo Canal",
"description": "Meu novo canal",
"cor": "#000000",
"Estrelado": Verdadeiro
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 3,
"name": "Novo Canal",
"description": "Meu novo canal",
"cor": "#000000",
"Estrelado": Verdadeiro
} https://urlkai.com/api/channel/:channelid/assign/:type/:itemid
Um item pode ser atribuído a qualquer canal enviando uma solicitação com o ID do canal, tipo de item (links, biografia ou qr) e ID do item.
| Parametro | Descrizione |
|---|---|
| :ID do canal | (obrigatório) ID do canal |
| :tipo | (obrigatório) links ou biografia ou QR |
| :itemid | (obrigatório) Item ID |
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("POST", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var solicitação = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "Item adicionado com sucesso ao canal."
} https://urlkai.com/api/channel/:id/update
Para atualizar um canal, você precisa enviar dados válidos em JSON por meio de uma solicitação PUT. Os dados devem ser enviados como o corpo bruto de sua solicitação, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| nome | (opcional) Nome do canal |
| descrição | (opcional) Descrição do canal |
| Cor | (opcional) Cor do emblema do canal (HEX) |
| Estrelou | (opcional) Marcar o canal com estrela ou não (verdadeiro ou falso) |
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"name": "Acme Corp",
"description": "canal para itens para a Acme Corp",
"cor": "#FFFFFF",
"estrelado": falso
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "COLOCAR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Acme Corp",
"description": "canal para itens para a Acme Corp",
"cor": "#FFFFFF",
"estrelado": falso
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'PUT',
'url': 'https://urlkai.com/api/channel/:id/update',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"name": "Acme Corp",
"description": "canal para itens para a Acme Corp",
"cor": "#FFFFFF",
"estrelado": falso
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/channel/:id/update"
carga = {
"name": "Acme Corp",
"description": "canal para itens para a Acme Corp",
"cor": "#FFFFFF",
"estrelado": falso
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("PUT", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Acme Corp",
"description": "canal para itens para a Acme Corp",
"cor": "#FFFFFF",
"estrelado": falso
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O canal foi atualizado com sucesso."
} https://urlkai.com/api/channel/:id/delete
Para excluir um canal, você precisa enviar uma solicitação DELETE. Todos os itens também serão não atribuídos.
curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "EXCLUIR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'DELETE',
'url': 'https://urlkai.com/api/channel/:id/delete',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/channel/:id/delete"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("DELETE", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O canal foi excluído com sucesso."
} https://urlkai.com/api/qr?limit=2&page=1
Per ottenere i tuoi codici QR tramite l'API, puoi utilizzare questo endpoint. Puoi anche filtrare i dati (vedi tabella per maggiori informazioni).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/qr?limit=2&page=1',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/qr?limit=2&page=1"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"qrs": [
{
"id": 2,
"link": "https:\/\/urlkai.com\/qr\/a2d5e",
"varreduras": 0,
"name": "Google",
"data": "2020-11-10 18:01:43"
},
{
"id": 1,
"link": "https:\/\/urlkai.com\/qr\/b9edfe",
"varreduras": 5,
"name": "Google Canadá",
"data": "2020-11-10 18:00:25"
}
]
}
} https://urlkai.com/api/qr/:id
Per ottenere i dettagli per un singolo codice QR tramite l'API, puoi utilizzare questo endpoint.
curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/qr/:id",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/qr/:id',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/qr/:id"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"detalhes": {
"id": 1,
"link": "https:\/\/urlkai.com\/qr\/b9edfe",
"varreduras": 5,
"name": "Google Canadá",
"data": "2020-11-10 18:00:25"
},
"dados": {
"cliques": 1,
"uniqueClicks": 1,
"topCountries": {
"Desconhecido": "1"
},
"topReferrers": {
"Direto, e-mail e outros": "1"
},
"topBrowsers": {
"Chrome": "1"
},
"topOs": {
"Windows 10": "1"
},
"socialCount": {
"facebook": 0,
"twitter": 0,
"Instagram": 0
}
}
} https://urlkai.com/api/qr/add
Para criar um QR Code, você precisa enviar um dado válido em JSON por meio de uma solicitação POST. Os dados devem ser enviados como o corpo bruto de sua solicitação, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| tipo | (obrigatório) texto | vcard | ligação | E-mail | telefone | sms | Wi-Fi |
| dados | (obrigatório) Dados a serem incorporados dentro do código QR. Os dados podem ser string ou array, dependendo do tipo |
| fundo | (opcional) Cor RGB, por exemplo, rgb (255.255.255) |
| primeiro plano | (opcional) Cor RGB, por exemplo, rgb(0,0,0) |
| logotipo | (opcional) Caminho para o logotipo png ou jpg |
| nome | (opcional) Nome do código QR |
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"tipo": "link",
"dados": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https:\/\/site.com\/logo.png",
"name": "API de código QR"
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/qr/add",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"tipo": "link",
"dados": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https:\/\/site.com\/logo.png",
"name": "API de código QR"
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/qr/add',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"tipo": "link",
"dados": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https:\/\/site.com\/logo.png",
"name": "API de código QR"
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/qr/add"
carga = {
"tipo": "link",
"dados": "https://google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logo": "https://site.com/logo.png",
"name": "API de código QR"
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("POST", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"tipo": "link",
"dados": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https:\/\/site.com\/logo.png",
"name": "API de código QR"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 3,
"link": "https:\/\/urlkai.com\/qr\/a58f79"
} https://urlkai.com/api/qr/:id/update
Per aggiornare un codice QR, devi inviare un dato valido in JSON tramite una richiesta PUT. I dati devono essere inviati come corpo grezzo della tua richiesta come mostrato di seguito. L'esempio seguente mostra tutti i parametri che puoi inviare ma non è necessario inviarli tutti (vedi tabella per maggiori informazioni).
| Parametro | Descrizione |
|---|---|
| dados | (obrigatório) Dados a serem incorporados dentro do código QR. Os dados podem ser string ou array, dependendo do tipo |
| fundo | (opcional) Cor RGB, por exemplo, rgb (255.255.255) |
| primeiro plano | (opcional) Cor RGB, por exemplo, rgb(0,0,0) |
| logotipo | (opcional) Caminho para o logotipo png ou jpg |
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"tipo": "link",
"dados": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https:\/\/site.com\/logo.png"
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "COLOCAR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"tipo": "link",
"dados": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https:\/\/site.com\/logo.png"
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'PUT',
'url': 'https://urlkai.com/api/qr/:id/update',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"tipo": "link",
"dados": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https:\/\/site.com\/logo.png"
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/qr/:id/update"
carga = {
"tipo": "link",
"dados": "https://google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https://site.com/logo.png"
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("PUT", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"tipo": "link",
"dados": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"primeiro plano": "rgb(0,0,0)",
"logotipo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O QR foi atualizado com sucesso."
} https://urlkai.com/api/qr/:id/delete
Per eliminare un codice QR, è necessario inviare una richiesta DELETE.
curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "EXCLUIR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'DELETE',
'url': 'https://urlkai.com/api/qr/:id/delete',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/qr/:id/delete"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("DELETE", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O QR Code foi excluído com sucesso."
} https://urlkai.com/api/domains?limit=2&page=1
Para obter seus domínios de marca por meio da API, você pode usar esse endpoint. Você também pode filtrar dados (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/domains?limit=2&page=1',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/domains?limit=2&page=1"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"domínios": [
{
"id": 1,
"domínio": "https:\/\/domain1.com",
"raiz de redirecionamento": "https:\/\/rootdomain.com",
"redirecionamento404": "https:\/\/rootdomain.com\/404"
},
{
"id": 2,
"domínio": "https:\/\/domain2.com",
"raiz de redirecionamento": "https:\/\/rootdomain2.com",
"redirect404": "https:\/\/rootdomain2.com\/404"
}
]
}
} https://urlkai.com/api/domain/add
Um domínio pode ser adicionado usando esse ponto de extremidade. Certifique-se de que o domínio esteja apontado corretamente para o nosso servidor.
| Parametro | Descrizione |
|---|---|
| domínio | (obrigatório) Domínio de marca, incluindo http ou https |
| raiz de redirecionamento | (opcional) Redirecionamento raiz quando alguém visita seu domínio |
| redirecionamento404 | (opcional) Redirecionamento 404 personalizado |
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"domínio": "https:\/\/domain1.com",
"raiz de redirecionamento": "https:\/\/rootdomain.com",
"redirecionamento404": "https:\/\/rootdomain.com\/404"
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/domain/add",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"domínio": "https:\/\/domain1.com",
"raiz de redirecionamento": "https:\/\/rootdomain.com",
"redirecionamento404": "https:\/\/rootdomain.com\/404"
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/domain/add',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"domínio": "https:\/\/domain1.com",
"raiz de redirecionamento": "https:\/\/rootdomain.com",
"redirecionamento404": "https:\/\/rootdomain.com\/404"
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/domain/add"
carga = {
"domínio": "https://domain1.com",
"redirectroot": "https://rootdomain.com",
"redirect404": "https://rootdomain.com/404"
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("POST", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"domínio": "https:\/\/domain1.com",
"raiz de redirecionamento": "https:\/\/rootdomain.com",
"redirecionamento404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 1
} https://urlkai.com/api/domain/:id/update
Para atualizar um domínio de marca, você precisa enviar dados válidos em JSON por meio de uma solicitação PUT. Os dados devem ser enviados como o corpo bruto de sua solicitação, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| raiz de redirecionamento | (opcional) Redirecionamento raiz quando alguém visita seu domínio |
| redirecionamento404 | (opcional) Redirecionamento 404 personalizado |
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"raiz de redirecionamento": "https:\/\/rootdomain-new.com",
"redirecionamento404": "https:\/\/rootdomain-new.com\/404"
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "COLOCAR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"raiz de redirecionamento": "https:\/\/rootdomain-new.com",
"redirecionamento404": "https:\/\/rootdomain-new.com\/404"
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'PUT',
'url': 'https://urlkai.com/api/domain/:id/update',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"raiz de redirecionamento": "https:\/\/rootdomain-new.com",
"redirecionamento404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/domain/:id/update"
carga = {
"redirectroot": "https://rootdomain-new.com",
"redirect404": "https://rootdomain-new.com/404"
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("PUT", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"raiz de redirecionamento": "https:\/\/rootdomain-new.com",
"redirecionamento404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O domínio foi atualizado com sucesso."
} https://urlkai.com/api/domain/:id/delete
Para excluir um domínio, você precisa enviar uma solicitação DELETE.
curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "EXCLUIR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'DELETE',
'url': 'https://urlkai.com/api/domain/:id/delete',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/domain/:id/delete"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("DELETE", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O domínio foi excluído com sucesso."
} https://urlkai.com/api/urls?limit=2&page=1o=date
Per ottenere i tuoi collegamenti tramite l'API, puoi utilizzare questo endpoint. Puoi anche filtrare i dati (vedi tabella per maggiori informazioni).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
| ordem | (opcional) Classificar dados entre data ou clique |
| curto | (opcional) Pesquise usando o url curto. Observe que, quando você usa o parâmetro short, todos os outros parâmetros são ignorados e, se houver uma correspondência, uma resposta de link único será retornada. |
| q | (opcional) Pesquisar links usando uma palavra-chave |
curl --location --request GET 'https://urlkai.com/api/urls?limit=2&page=1o=date' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/urls?limit=2&page=1o=date",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/urls?limit=2&page=1o=date',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/urls?limit=2&page=1o=date"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/urls?limit=2&page=1o=date");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"urls": [
{
"id": 2,
"alias": "google",
"shorturl": "https:\/\/urlkai.com\/google",
"longurl": "https:\/\/google.com",
"cliques": 0,
"title": "Google",
"description": "",
"data": "2020-11-10 18:01:43"
},
{
"id": 1,
"alias": "googlecanada",
"shorturl": "https:\/\/urlkai.com\/googlecanada",
"longurl": "https:\/\/google.ca",
"cliques": 0,
"title": "Google Canadá",
"description": "",
"data": "2020-11-10 18:00:25"
}
]
}
} https://urlkai.com/api/url/:id
Per ottenere i dettagli per un singolo collegamento tramite l'API, puoi utilizzare questo endpoint.
curl --location --request GET 'https://urlkai.com/api/url/:id' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/url/:id",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/url/:id',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/url/:id"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var solicitação = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/url/:id");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 1,
"detalhes": {
"id": 1,
"shorturl": "https:\/\/urlkai.com\/googlecanada",
"longurl": "https:\/\/google.com",
"title": "Google",
"description": "",
"localização": {
"Canadá": "https:\/\/google.ca",
"Estados Unidos": "https:\/\/google.us"
},
"dispositivo": {
"iphone": "https:\/\/google.com",
"android": "https:\/\/google.com"
},
"expiração": nulo,
"data": "2020-11-10 18:01:43"
},
"dados": {
"cliques": 0,
"uniqueClicks": 0,
"topCountries": 0,
"topReferrers": 0,
"topBrowsers": 0,
"topOs": 0,
"socialCount": {
"facebook": 0,
"twitter": 0,
"google": 0
}
}
} https://urlkai.com/api/url/add
Per abbreviare un collegamento, devi inviare un dato valido in JSON tramite una richiesta POST. I dati devono essere inviati come corpo grezzo della tua richiesta come mostrato di seguito. L'esempio seguente mostra tutti i parametri che puoi inviare ma non è necessario inviarli tutti (vedi tabella per maggiori informazioni).
| Parametro | Descrizione |
|---|---|
| URL | (obrigatório) URL longo para encurtar. |
| costume | (opcional) Alias personalizado em vez de alias aleatório. |
| tipo | (opcional) Tipo de redirecionamento [direto, quadro, splash], apenas id para página inicial personalizada ou ID de sobreposição Para páginas CTA |
| senha | (opcional) Proteção por senha |
| domínio | (opcional) Domínio personalizado |
| caducidade | (opcional) Expiração para o exemplo de link 2021-09-28 23:11:16 |
| Segmentação geográfica | (opcional) Dados de segmentação geográfica |
| alvo do dispositivo | (opcional) Dados de segmentação por dispositivo |
| IdiomaAlvo | (opcional) Dados de segmentação por idioma |
| metatítulo | (opcional) Meta título |
| Metadescrição | (opcional) Meta descrição |
| meta-imagem | (opcional) Link para uma imagem jpg ou png |
| descrição | (opcional) Nota ou descrição |
| Pixels | (opcional) Matriz de IDs de pixel |
| canal | (opcional) ID do canal |
| campanha | (opcional) ID da campanha |
| link direto | (opcional) Objeto que contém links da loja de aplicativos. Ao usar isso, é importante definir a segmentação por dispositivo também. (Novo) Agora você pode definir o parâmetro "auto" como true para gerar automaticamente os links diretos do link longo fornecido. |
| estado | (opcional) público ou privado (padrão) |
curl --location --request POST 'https://urlkai.com/api/url/add' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"url": "https:\/\/google.com",
"status": "privado",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"metatitle": "Não é Google",
"metadescription": "Não é uma descrição do Google",
"metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
"description": "Para o facebook",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"campanha": 1,
"deeplink": {
"auto": true,
"apple": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https:\/\/google.ca"
},
{
"location": "Estados Unidos",
"link": "https:\/\/google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"dispositivo": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"língua": "en",
"link": "https:\/\/google.com"
},
{
"idioma": "fr",
"link": "https:\/\/google.ca"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/url/add",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"url": "https:\/\/google.com",
"status": "privado",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"metatitle": "Não é Google",
"metadescription": "Não é uma descrição do Google",
"metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
"description": "Para o facebook",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"campanha": 1,
"deeplink": {
"auto": true,
"apple": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https:\/\/google.ca"
},
{
"location": "Estados Unidos",
"link": "https:\/\/google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"dispositivo": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"língua": "en",
"link": "https:\/\/google.com"
},
{
"idioma": "fr",
"link": "https:\/\/google.ca"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/url/add',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"url": "https:\/\/google.com",
"status": "privado",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"metatitle": "Não é Google",
"metadescription": "Não é uma descrição do Google",
"metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
"description": "Para o facebook",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"campanha": 1,
"deeplink": {
"auto": true,
"apple": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https:\/\/google.ca"
},
{
"location": "Estados Unidos",
"link": "https:\/\/google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"dispositivo": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"língua": "en",
"link": "https:\/\/google.com"
},
{
"idioma": "fr",
"link": "https:\/\/google.ca"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/url/add"
carga = {
"url": "https://google.com",
"status": "privado",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"metatitle": "Não é Google",
"metadescription": "Não é uma descrição do Google",
"metaimage": "https://www.mozilla.org/media/protocol/img/logos/firefox/browser/og.4ad05d4125a5.png",
"description": "Para o facebook",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"campanha": 1,
"deeplink": {
"auto": true,
"maçã": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https://google.ca"
},
{
"location": "Estados Unidos",
"link": "https://google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https://google.com"
},
{
"dispositivo": "Android",
"link": "https://google.com"
}
],
"languagetarget": [
{
"língua": "en",
"link": "https://google.com"
},
{
"idioma": "fr",
"link": "https://google.ca"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("POST", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var solicitação = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/url/add");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"url": "https:\/\/google.com",
"status": "privado",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"metatitle": "Não é Google",
"metadescription": "Não é uma descrição do Google",
"metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
"description": "Para o facebook",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"campanha": 1,
"deeplink": {
"auto": true,
"apple": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https:\/\/google.ca"
},
{
"location": "Estados Unidos",
"link": "https:\/\/google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"dispositivo": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"língua": "en",
"link": "https:\/\/google.com"
},
{
"idioma": "fr",
"link": "https:\/\/google.ca"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 3,
"shorturl": "https:\/\/urlkai.com\/google"
} https://urlkai.com/api/url/:id/update
Per aggiornare un collegamento, devi inviare un dato valido in JSON tramite una richiesta PUT. I dati devono essere inviati come corpo grezzo della tua richiesta come mostrato di seguito. L'esempio seguente mostra tutti i parametri che puoi inviare ma non è necessario inviarli tutti (vedi tabella per maggiori informazioni).
| Parametro | Descrizione |
|---|---|
| URL | (obrigatório) URL longo para encurtar. |
| costume | (opcional) Alias personalizado em vez de alias aleatório. |
| tipo | (opcional) Tipo de redirecionamento [direto, quadro, respingo] |
| senha | (opcional) Proteção por senha |
| domínio | (opcional) Domínio personalizado |
| caducidade | (opcional) Expiração para o exemplo de link 2021-09-28 23:11:16 |
| Segmentação geográfica | (opcional) Dados de segmentação geográfica |
| alvo do dispositivo | (opcional) Dados de segmentação por dispositivo |
| IdiomaAlvo | (opcional) Dados de segmentação por idioma |
| metatítulo | (opcional) Meta título |
| Metadescrição | (opcional) Meta descrição |
| meta-imagem | (opcional) Link para uma imagem jpg ou png |
| Pixels | (opcional) Matriz de IDs de pixel |
| canal | (opcional) ID do canal |
| campanha | (opcional) ID da campanha |
| link direto | (opcional) Objeto que contém links da loja de aplicativos. Ao usar isso, é importante definir a segmentação por dispositivo também. |
curl --location --request PUT 'https://urlkai.com/api/url/:id/update' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"url": "https:\/\/google.com",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"deeplink": {
"apple": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https:\/\/google.ca"
},
{
"location": "Estados Unidos",
"link": "https:\/\/google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"dispositivo": "Android",
"link": "https:\/\/google.com"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/url/:id/update",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "COLOCAR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"url": "https:\/\/google.com",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"deeplink": {
"apple": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https:\/\/google.ca"
},
{
"location": "Estados Unidos",
"link": "https:\/\/google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"dispositivo": "Android",
"link": "https:\/\/google.com"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'PUT',
'url': 'https://urlkai.com/api/url/:id/update',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"url": "https:\/\/google.com",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"deeplink": {
"apple": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https:\/\/google.ca"
},
{
"location": "Estados Unidos",
"link": "https:\/\/google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"dispositivo": "Android",
"link": "https:\/\/google.com"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/url/:id/update"
carga = {
"url": "https://google.com",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"deeplink": {
"maçã": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https://google.ca"
},
{
"location": "Estados Unidos",
"link": "https://google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https://google.com"
},
{
"dispositivo": "Android",
"link": "https://google.com"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("PUT", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/url/:id/update");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"url": "https:\/\/google.com",
"personalizado": "google",
"password": "mypass",
"expiração": "2020-11-11 12:00:00",
"tipo": "respingo",
"pixels": [
1,
2,
3,
4
],
"canal": 1,
"deeplink": {
"apple": "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"
},
"alvo geográfico": [
{
"location": "Canadá",
"link": "https:\/\/google.ca"
},
{
"location": "Estados Unidos",
"link": "https:\/\/google.us"
}
],
"Destino do dispositivo": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"dispositivo": "Android",
"link": "https:\/\/google.com"
}
],
"parâmetros": [
{
"nome": "aff",
"valor": "3"
},
{
"dispositivo": "gtm_source",
"link": "api"
}
]
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 3,
"curto": "https:\/\/urlkai.com\/google"
} https://urlkai.com/api/url/:id/delete
Per eliminare un collegamento, è necessario inviare una richiesta DELETE.
curl --location --request DELETE 'https://urlkai.com/api/url/:id/delete' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/url/:id/delete",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "EXCLUIR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'DELETE',
'url': 'https://urlkai.com/api/url/:id/delete',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/url/:id/delete"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("DELETE", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/url/:id/delete");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O link foi excluído com sucesso"
} https://urlkai.com/api/overlay?limit=2&page=1
Para obter sobreposições de cta por meio da API, você pode usar esse endpoint. Você também pode filtrar dados (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/overlay?limit=2&page=1"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"cta": [
{
"id": 1,
"tipo": "mensagem",
"name": "Promoção do Produto 1",
"data": "2020-11-10 18:00:00"
},
{
"id": 2,
"tipo": "contato",
"name": "Página de contato",
"data": "2020-11-10 18:10:00"
}
]
}
} https://urlkai.com/api/pixels?limit=2&page=1
Para obter seus códigos de pixels por meio da API, você pode usar esse endpoint. Você também pode filtrar dados (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/pixels?limit=2&page=1"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var solicitação = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"pixels": [
{
"id": 1,
"tipo": "gtmpixel",
"name": "Pixel GTM",
"tag": "GA-123456789",
"data": "2020-11-10 18:00:00"
},
{
"id": 2,
"tipo": "twitterpixel",
"name": "Pixel do Twitter",
"tag": "1234567",
"data": "2020-11-10 18:10:00"
}
]
}
} https://urlkai.com/api/pixel/add
Um pixel pode ser criado usando esse ponto de extremidade. Você precisa enviar o tipo de pixel e a tag.
| Parametro | Descrizione |
|---|---|
| tipo | (obrigatório) gtmpixel | gapixel | fbpixel | AdwordsPixel | linkedinpixel | twitterpixel | AdrollPixel | Quorapixel | Pinterest | bing | Snapchat | Reddit | Tiktok |
| nome | (obrigatório) Nome personalizado para o pixel |
| etiqueta | (obrigatório) A tag para o pixel |
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"tipo": "gtmpixel",
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/pixel/add",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"tipo": "gtmpixel",
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'POST',
'url': 'https://urlkai.com/api/pixel/add',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"tipo": "gtmpixel",
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/pixel/add"
carga = {
"tipo": "gtmpixel",
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("POST", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"tipo": "gtmpixel",
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"id": 1
} https://urlkai.com/api/pixel/:id/update
Para atualizar um pixel, você precisa enviar dados válidos em JSON por meio de uma solicitação PUT. Os dados devem ser enviados como o corpo bruto de sua solicitação, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| nome | (opcional) Nome personalizado para o pixel |
| etiqueta | (obrigatório) A tag para o pixel |
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \
--data-raw '{
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}' $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "COLOCAR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}',
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'PUT',
'url': 'https://urlkai.com/api/pixel/:id/update',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
corpo: JSON.stringify({
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}),
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/pixel/:id/update"
carga = {
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("PUT", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var solicitação = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Meu GTM",
"tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O pixel foi atualizado com sucesso."
} https://urlkai.com/api/pixel/:id/delete
Para excluir um pixel, você precisa enviar uma solicitação DELETE.
curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "EXCLUIR",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'DELETE',
'url': 'https://urlkai.com/api/pixel/:id/delete',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/pixel/:id/delete"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("DELETE", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": 0,
"message": "O pixel foi excluído com sucesso."
} https://urlkai.com/api/splash?limit=2&page=1
Para obter páginas iniciais personalizadas por meio da API, você pode usar esse endpoint. Você também pode filtrar dados (consulte a tabela para obter mais informações).
| Parametro | Descrizione |
|---|---|
| limite | (opcional) Resultado de dados por página |
| página | (opcional) Solicitação de página atual |
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Autorização: Portador YOURAPIKEY' \
--header 'Tipo de conteúdo: aplicativo / json' \ $curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
CURLOPT_RETURNTRANSFER => verdadeiro,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT = > 10,
CURLOPT_FOLLOWLOCATION => verdadeiro,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Autorização: Portador YOURAPIKEY",
"Tipo de conteúdo: application/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
eco $response; var solicitação = require('solicitação');
var opções = {
'method': 'GET',
'url': 'https://urlkai.com/api/splash?limit=2&page=1',
'cabeçalhos': {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
},
};
request(opções, função (erro, resposta) {
if (error) throw new Error(error);
console.log(resposta.corpo);
}); Solicitações de importação
url = "https://urlkai.com/api/splash?limit=2&page=1"
carga = {}
cabeçalhos = {
'Autorização': 'Portador YOURAPIKEY',
'Tipo de conteúdo': 'aplicativo / json'
}
resposta = requests.request("GET", url, cabeçalhos=cabeçalhos, json=payload)
print(resposta.texto) var cliente = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
pedir. Headers.Add("Autorização", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Conteúdo = conteúdo;
var response = await client. SendAsync(solicitação);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); {
"erro": "0",
"dados": {
"resultado": 2,
"perpage": 2,
"página atual": 1,
"próxima página": 1,
"maxpage": 1,
"splash": [
{
"id": 1,
"name": "Promoção do Produto 1",
"data": "2020-11-10 18:00:00"
},
{
"id": 2,
"name": "Promoção do Produto 2",
"data": "2020-11-10 18:10:00"
}
]
}
}