En API-nøkkel kreves for at forespørsler skal behandles av systemet. Når en bruker registrerer seg, genereres det automatisk en API-nøkkel for denne brukeren. API-nøkkelen må sendes med hver forespørsel (se fullstendig eksempel nedenfor). Hvis API-nøkkelen ikke sendes eller er utløpt, vil det oppstå en feil. Sørg for å holde API-nøkkelen hemmelig for å forhindre misbruk.
For å autentisere med API-systemet, må du sende API-nøkkelen din som et autorisasjonstoken med hver forespørsel. Du kan se eksempelkoden nedenfor.
curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/account",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl); var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/account',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: ''
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/account"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); API-en vår har en hastighetsbegrenser for å beskytte mot økning i forespørsler for å maksimere stabiliteten. Satsbegrenseren vår er for øyeblikket begrenset til 30 forespørsler per 1 minutt. Tingues en compte que la tarifa pot variar segons el pla subscrit.
Flere overskrifter vil bli sendt ved siden av svaret, og disse kan undersøkes for å finne ulike opplysninger om forespørselen.
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Alle API-svar returneres som standard i JSON-format. For å konvertere dette til brukbare data, må den aktuelle funksjonen brukes i henhold til språket. I PHP kan funksjonen json_decode() brukes til å konvertere dataene til enten et objekt (standard) eller en matrise (sett den andre parameteren til true). Det er veldig viktig å sjekke feilnøkkelen, da den gir informasjon om det var en feil eller ikke. Du kan også sjekke overskriftskoden.
{
"error": 1,
"message": "An error occurred"
}https://urlkai.com/api/overlay?limit=2&page=1
Per obtenir superposicions de CTA mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/overlay?limit=2&page=1"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"cta": [
{
"id": 1,
"type": "missatge",
"name": "Promoció del producte 1",
"data": "2020-11-10 18:00:00"
},
{
"identificació": 2,
"type": "contacte",
"name": "Pàgina de contacte",
"data": "2020-11-10 18:10:00"
}
]
}
} https://urlkai.com/api/campaigns?limit=2&page=1
Per obtenir les campanyes a través de l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"campanyes": [
{
"id": 1,
"name": "Campanya de mostra",
"públic": fals,
"rotador": fals,
"list": "https:\/\/domain.com\/u\/admin\/list-1"
},
{
"identificació": 2,
"domain": "Campanya de Facebook",
"públic": cert,
"rotator": "https:\/\/domain.com\/r\/test",
"list": "https:\/\/domain.com\/u\/admin\/test-2"
}
]
}
} https://urlkai.com/api/campaign/add
Es pot afegir una campanya mitjançant aquest punt final.
| Paràmetre | Beskrivelse |
|---|---|
| nom | (opcional) Nom de la campanya |
| llimac | (opcional) Llimac rotador |
| públic | (opcional) Accés |
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"name": "Nova campanya",
"llimac": "nova campanya",
"públic": cert
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/campaign/add",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Nova campanya",
"llimac": "nova campanya",
"públic": cert
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/campaign/add',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"name": "Nova campanya",
"llimac": "nova campanya",
"públic": cert
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/campaign/add"
càrrega útil = {
"name": "Nova campanya",
"llimac": "nova campanya",
"públic": cert
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Nova campanya",
"llimac": "nova campanya",
"públic": cert
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"identificació": 3,
"domain": "Nova campanya",
"públic": cert,
"rotator": "https:\/\/domain.com\/r\/nova-campanya",
"list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} https://urlkai.com/api/campaign/:campaignid/assign/:linkid
Es pot assignar un enllaç curt a una campanya mitjançant aquest punt final. El punt final requereix l'identificador de campanya i l'identificador d'enllaç curt.
curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "Enllaç afegit correctament a la campanya".
} https://urlkai.com/api/campaign/:id/update
Per actualitzar una campanya, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud PUT. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).
| Paràmetre | Beskrivelse |
|---|---|
| nom | (obligatori) Nom de la campanya |
| llimac | (opcional) Llimac rotador |
| públic | (opcional) Accés |
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"name": "Campanya de Twitter",
"llimac": "campanya de Twitter",
"públic": cert
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "POSAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Campanya de Twitter",
"llimac": "campanya de Twitter",
"públic": cert
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'PUT',
'url': 'https://urlkai.com/api/campaign/:id/update',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"name": "Campanya de Twitter",
"llimac": "campanya de Twitter",
"públic": cert
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/campaign/:id/update"
càrrega útil = {
"name": "Campanya de Twitter",
"llimac": "campanya de Twitter",
"públic": cert
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Campanya de Twitter",
"llimac": "campanya de Twitter",
"públic": cert
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"identificació": 3,
"domain": "Campanya de Twitter",
"públic": cert,
"rotator": "https:\/\/domain.com\/r\/twitter-campaign",
"list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} https://urlkai.com/api/campaign/:id/delete
Per suprimir una campanya, heu d'enviar una sol·licitud de supressió.
curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "ESBORRAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'SUPRIMEIX',
'url': 'https://urlkai.com/api/campaign/:id/delete',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/campaign/:id/delete"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "La campanya s'ha suprimit correctament".
} https://urlkai.com/api/channels?limit=2&page=1
Per obtenir els vostres canals mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/channels?limit=2&page=1',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/channels?limit=2&page=1"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"canals": [
{
"id": 1,
"name": "Canal 1",
"description": "Descripció del canal 1",
"color": "#000000",
"Starred": Cert
},
{
"identificació": 2,
"name": "Canal 2",
"description": "Descripció del canal 2",
"color": "#FF0000",
"Starred": fals
}
]
}
} https://urlkai.com/api/channel/:id?limit=1&page=1
Per obtenir elements en un canal seleccionat mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"articles": [
{
"type": "enllaços",
"id": 1,
"title": "El meu enllaç de mostra",
"preview": "https:\/\/google.com",
"link": "https:\/\/urlkai.com\/google",
"data": "2022-05-12"
},
{
"type": "bio",
"id": 1,
"title": "La meva biografia de mostra",
"preview": "https:\/\/urlkai.com\/mybio",
"link": "https:\/\/urlkai.com\/mybio",
"data": "2022-06-01"
}
]
}
} https://urlkai.com/api/channel/add
Es pot afegir un canal mitjançant aquest punt final.
| Paràmetre | Beskrivelse |
|---|---|
| nom | (obligatori) Nom del canal |
| descripció | (opcional) Descripció del canal |
| color | (opcional) Color de la insígnia del canal (HEX) |
| Protagonista | (opcional) Estrella del canal o no (cert o fals) |
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"name": "Canal nou",
"description": "el meu nou canal",
"color": "#000000",
"Starred": Cert
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/channel/add",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Canal nou",
"description": "el meu nou canal",
"color": "#000000",
"Starred": Cert
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/channel/add',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"name": "Canal nou",
"description": "el meu nou canal",
"color": "#000000",
"Starred": Cert
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/channel/add"
càrrega útil = {
"name": "Canal nou",
"description": "el meu nou canal",
"color": "#000000",
"Starred": Cert
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Canal nou",
"description": "el meu nou canal",
"color": "#000000",
"Starred": Cert
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"identificació": 3,
"name": "Canal nou",
"description": "el meu nou canal",
"color": "#000000",
"Starred": Cert
} https://urlkai.com/api/channel/:channelid/assign/:type/:itemid
Es pot assignar un element a qualsevol canal enviant una sol·licitud amb l'identificador del canal, el tipus d'element (enllaços, biografia o qr) i l'identificador de l'element.
| Paràmetre | Beskrivelse |
|---|---|
| :identificador de canal | (obligatori) Identificador del canal |
| :tipus | (obligatori) Enllaços o biografia o QR |
| :itemid | (obligatori) Identificador de l'element |
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "L'element s'ha afegit correctament al canal".
} https://urlkai.com/api/channel/:id/update
Per actualitzar un canal, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud PUT. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).
| Paràmetre | Beskrivelse |
|---|---|
| nom | (opcional) Nom del canal |
| descripció | (opcional) Descripció del canal |
| color | (opcional) Color de la insígnia del canal (HEX) |
| Protagonista | (opcional) Estrella del canal o no (cert o fals) |
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"name": "Acme Corp",
"description": "canal d'articles per a Acme Corp",
"color": "#FFFFFF",
"Starred": fals
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "POSAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Acme Corp",
"description": "canal d'articles per a Acme Corp",
"color": "#FFFFFF",
"Starred": fals
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'PUT',
'url': 'https://urlkai.com/api/channel/:id/update',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"name": "Acme Corp",
"description": "canal d'articles per a Acme Corp",
"color": "#FFFFFF",
"Starred": fals
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/channel/:id/update"
càrrega útil = {
"name": "Acme Corp",
"description": "canal d'articles per a Acme Corp",
"color": "#FFFFFF",
"Starred": fals
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "Acme Corp",
"description": "canal d'articles per a Acme Corp",
"color": "#FFFFFF",
"Starred": fals
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "El canal s'ha actualitzat correctament".
} https://urlkai.com/api/channel/:id/delete
Per suprimir un canal, heu d'enviar una sol·licitud de supressió. Tots els elements també es desassignaran.
curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "ESBORRAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'SUPRIMEIX',
'url': 'https://urlkai.com/api/channel/:id/delete',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/channel/:id/delete"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "El canal s'ha suprimit correctament".
} https://urlkai.com/api/domains?limit=2&page=1
Per obtenir els vostres dominis de marca mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/domains?limit=2&page=1',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/domains?limit=2&page=1"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"dominis": [
{
"id": 1,
"domini": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
},
{
"identificació": 2,
"domini": "https:\/\/domain2.com",
"redirectroot": "https:\/\/rootdomain2.com",
"redirect404": "https:\/\/rootdomain2.com\/404"
}
]
}
} https://urlkai.com/api/domain/add
Es pot afegir un domini mitjançant aquest punt final. Si us plau, assegureu-vos que el domini estigui correctament apuntat al nostre servidor.
| Paràmetre | Beskrivelse |
|---|---|
| domini | (obligatori) Domini de marca que inclou http o https |
| redireccióarrel | (opcional) Redirecció arrel quan algú visita el vostre domini |
| redirecció404 | (opcional) Redirecció 404 personalitzada |
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"domini": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/domain/add",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"domini": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/domain/add',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"domini": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/domain/add"
càrrega útil = {
"domini": "https://domain1.com",
"redirectroot": "https://rootdomain.com",
"redirect404": "https://rootdomain.com/404"
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"domini": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"identificació": 1
} https://urlkai.com/api/domain/:id/update
Per actualitzar un domini de marca, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud PUT. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).
| Paràmetre | Beskrivelse |
|---|---|
| redireccióarrel | (opcional) Redirecció arrel quan algú visita el vostre domini |
| redirecció404 | (opcional) Redirecció 404 personalitzada |
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"redirectroot": "https:\/\/rootdomain-new.com",
"redirect404": "https:\/\/rootdomain-new.com\/404"
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "POSAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"redirectroot": "https:\/\/rootdomain-new.com",
"redirect404": "https:\/\/rootdomain-new.com\/404"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'PUT',
'url': 'https://urlkai.com/api/domain/:id/update',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"redirectroot": "https:\/\/rootdomain-new.com",
"redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/domain/:id/update"
càrrega útil = {
"redirectroot": "https://rootdomain-new.com",
"redirect404": "https://rootdomain-new.com/404"
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"redirectroot": "https:\/\/rootdomain-new.com",
"redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "El domini s'ha actualitzat correctament".
} https://urlkai.com/api/domain/:id/delete
Per suprimir un domini, heu d'enviar una sol·licitud de supressió.
curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "ESBORRAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'SUPRIMEIX',
'url': 'https://urlkai.com/api/domain/:id/delete',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/domain/:id/delete"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "El domini s'ha suprimit correctament".
} https://urlkai.com/api/qr?limit=2&page=1
For å få QR-kodene dine via API, kan du bruke dette endepunktet. Du kan også filtrere data (se tabell for mer info).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/qr?limit=2&page=1',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/qr?limit=2&page=1"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"qrs": [
{
"identificació": 2,
"link": "https:\/\/urlkai.com\/qr\/a2d5e",
"escaneigs": 0,
"name": "Google",
"data": "2020-11-10 18:01:43"
},
{
"id": 1,
"enllaç": "https:\/\/urlkai.com\/qr\/b9edfe",
"escaneigs": 5,
"name": "Google Canadà",
"data": "2020-11-10 18:00:25"
}
]
}
} https://urlkai.com/api/qr/:id
For å få detaljer for en enkelt QR-kode via API, kan du bruke dette endepunktet.
curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/qr/:id",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/qr/:id',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/qr/:id"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"detalls": {
"id": 1,
"enllaç": "https:\/\/urlkai.com\/qr\/b9edfe",
"escaneigs": 5,
"name": "Google Canadà",
"data": "2020-11-10 18:00:25"
},
"dades": {
"clics": 1,
"uniqueClicks": 1,
"topCountries": {
"Desconegut": "1"
},
"topReferrers": {
"Directe, correu electrònic i altres": "1"
},
"topBrowsers": {
"Chrome": "1"
},
"topOs": {
"Windows 10": "1"
},
"socialCount": {
"Facebook": 0,
"Twitter": 0,
"Instagram": 0
}
}
} https://urlkai.com/api/qr/add
Per crear un codi QR, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud POST. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).
| Paràmetre | Beskrivelse |
|---|---|
| tipus | text (obligatori) | vcard | Enllaç | correu electrònic | telèfon | Sms | Wifi |
| dades | (obligatori) Dades a incrustar dins del codi QR. Les dades poden ser de cadena o matriu segons el tipus |
| fons | (opcional) Color RGB, per exemple, rgb (255,255,255) |
| Primer pla | (opcional) Color RGB, per exemple, rgb(0,0,0) |
| logo | (opcional) Camí cap al logotip png o jpg |
| nom | (opcional) Nom del codi QR |
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"type": "enllaç",
"dades": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png",
"name": "API de codi QR"
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/qr/add",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"type": "enllaç",
"dades": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png",
"name": "API de codi QR"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/qr/add',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"type": "enllaç",
"dades": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png",
"name": "API de codi QR"
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/qr/add"
càrrega útil = {
"type": "enllaç",
"data": "https://google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https://site.com/logo.png",
"name": "API de codi QR"
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"type": "enllaç",
"dades": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png",
"name": "API de codi QR"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"identificació": 3,
"enllaç": "https:\/\/urlkai.com\/qr\/a58f79"
} https://urlkai.com/api/qr/:id/update
For å oppdatere en QR-kode, må du sende en gyldig data i JSON via en PUT-forespørsel. Dataene må sendes som råteksten til forespørselen din som vist nedenfor. Eksemplet nedenfor viser alle parameterne du kan sende, men du er ikke pålagt å sende alle (se tabellen for mer info).
| Paràmetre | Beskrivelse |
|---|---|
| dades | (obligatori) Dades a incrustar dins del codi QR. Les dades poden ser de cadena o matriu segons el tipus |
| fons | (opcional) Color RGB, per exemple, rgb (255,255,255) |
| Primer pla | (opcional) Color RGB, per exemple, rgb(0,0,0) |
| logo | (opcional) Camí cap al logotip png o jpg |
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"type": "enllaç",
"dades": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png"
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "POSAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"type": "enllaç",
"dades": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'PUT',
'url': 'https://urlkai.com/api/qr/:id/update',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"type": "enllaç",
"dades": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png"
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/qr/:id/update"
càrrega útil = {
"type": "enllaç",
"data": "https://google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https://site.com/logo.png"
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"type": "enllaç",
"dades": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"foreground": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "El QR s'ha actualitzat correctament".
} https://urlkai.com/api/qr/:id/delete
For å slette en QR-kode må du sende en SLETT-forespørsel.
curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "ESBORRAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'SUPRIMEIX',
'url': 'https://urlkai.com/api/qr/:id/delete',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/qr/:id/delete"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "El codi QR s'ha suprimit correctament".
} https://urlkai.com/api/account
For å få informasjon om kontoen kan du sende en forespørsel til dette endepunktet og det vil returnere data på kontoen.
curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/account",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/account',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/account"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"dades": {
"id": 1,
"correu electrònic": " [protegit per correu electrònic] ",
"nom d'usuari": "usuarisample",
"avatar": "https:\/\/domain.com\/content\/avatar.png",
"status": "pro",
"caduca": "2022-11-15 15:00:00",
"Registrat": "2020-11-10 18:01:43"
}
} https://urlkai.com/api/account/update
For å oppdatere informasjon om kontoen, kan du sende en forespørsel til dette endepunktet, og det vil oppdatere data på kontoen.
curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"correu electrònic": " [protegit per correu electrònic] ",
"password": "contrasenya nova"
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/account/update",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "POSAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"correu electrònic": " [protegit per correu electrònic] ",
"password": "contrasenya nova"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'PUT',
'url': 'https://urlkai.com/api/account/update',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"correu electrònic": " [protegit per correu electrònic] ",
"password": "contrasenya nova"
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/account/update"
càrrega útil = {
"correu electrònic": " [protegit per correu electrònic] ",
"password": "contrasenya nova"
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"correu electrònic": " [protegit per correu electrònic] ",
"password": "contrasenya nova"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "El compte s'ha actualitzat correctament".
} https://urlkai.com/api/splash?limit=2&page=1
Per obtenir pàgines de presentació personalitzades mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/splash?limit=2&page=1',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/splash?limit=2&page=1"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"esquitxada": [
{
"id": 1,
"name": "Promoció del producte 1",
"data": "2020-11-10 18:00:00"
},
{
"identificació": 2,
"name": "Promoció del producte 2",
"data": "2020-11-10 18:10:00"
}
]
}
} https://urlkai.com/api/urls?limit=2&page=1o=date
For å få koblingene dine via API, kan du bruke dette endepunktet. Du kan også filtrere data (se tabell for mer info).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
| ordre | (opcional) Ordenar les dades entre data o clic |
| curt | (opcional) Cerca amb l'URL curt. Tingueu en compte que quan utilitzeu el paràmetre short, tots els altres paràmetres s'ignoren i si hi ha una coincidència es retornarà una resposta d'enllaç únic. |
| q | (opcional) Cercar enllaços amb una paraula clau |
curl --location --request GET 'https://urlkai.com/api/urls?limit=2&page=1o=date' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/urls?limit=2&page=1o=date",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/urls?limit=2&page=1o=date',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/urls?limit=2&page=1o=date"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/urls?limit=2&page=1o=date");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"URLS": [
{
"identificació": 2,
"alias": "google",
"shorturl": "https:\/\/urlkai.com\/google",
"longurl": "https:\/\/google.com",
"clics": 0,
"title": "Google",
"descripció": "",
"data": "2020-11-10 18:01:43"
},
{
"id": 1,
"alias": "googlecanada",
"shorturl": "https:\/\/urlkai.com\/googlecanada",
"longurl": "https:\/\/google.ca",
"clics": 0,
"title": "Google Canadà",
"descripció": "",
"data": "2020-11-10 18:00:25"
}
]
}
} https://urlkai.com/api/url/:id
For å få detaljer for en enkelt lenke via API, kan du bruke dette endepunktet.
curl --location --request GET 'https://urlkai.com/api/url/:id' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/url/:id",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/url/:id',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/url/:id"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/url/:id");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"id": 1,
"detalls": {
"id": 1,
"shorturl": "https:\/\/urlkai.com\/googlecanada",
"longurl": "https:\/\/google.com",
"title": "Google",
"descripció": "",
"Ubicació": {
"canadà": "https:\/\/google.ca",
"Estats Units": "https:\/\/google.us"
},
"dispositiu": {
"iPhone": "https:\/\/google.com",
"android": "https:\/\/google.com"
},
"caducitat": nul·la,
"data": "2020-11-10 18:01:43"
},
"dades": {
"clics": 0,
"uniqueClicks": 0,
"topCountries": 0,
"topReferrers": 0,
"topBrowsers": 0,
"topOs": 0,
"socialCount": {
"Facebook": 0,
"Twitter": 0,
"google": 0
}
}
} https://urlkai.com/api/url/add
For å forkorte en lenke, må du sende en gyldig data i JSON via en POST-forespørsel. Dataene må sendes som råteksten til forespørselen din som vist nedenfor. Eksemplet nedenfor viser alle parameterne du kan sende, men du er ikke pålagt å sende alle (se tabellen for mer info).
| Paràmetre | Beskrivelse |
|---|---|
| Adreça URL | (obligatori) URL llarg per escurçar. |
| costum | (opcional) Àlies personalitzat en lloc d'àlies aleatori. |
| tipus | (opcional) Tipus de redirecció [directe, frame, splash], només id per a la pàgina d'inici personalitzada o identificador de superposició Per a pàgines CTA |
| contrasenya | (opcional) Protecció amb contrasenya |
| domini | (opcional) Domini personalitzat |
| Caducitat | (opcional) Caducitat de l'exemple d'enllaç 2021-09-28 23:11:16 |
| Geotarget | (opcional) Dades de segmentació geogràfica |
| devicetarget | (opcional) Dades de segmentació per dispositiu |
| LanguageTarget | (opcional) Dades de segmentació per idioma |
| metatítol | (opcional) Meta títol |
| metadescripció | (opcional) Meta descripció |
| metaimatge | (opcional) Enllaçar a una imatge jpg o png |
| descripció | (opcional) Nota o descripció |
| Píxels | (opcional) Array d'identificadors de píxels |
| canal | (opcional) Identificador del canal |
| campanya | (opcional) Identificador de campanya |
| enllaç profund | (opcional) Objecte que conté enllaços a la botiga d'aplicacions. Quan s'utilitza això, és important establir també l'orientació per dispositiu. (Nou) Ara podeu establir el paràmetre "auto" a true per generar automàticament els enllaços profunds a partir de l'enllaç llarg proporcionat. |
| estatus | (opcional) públic o privat (per defecte) |
curl --location --request POST 'https://urlkai.com/api/url/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"url": "https:\/\/google.com",
"status": "privat",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"metatitle": "No Google",
"metadescription": "No és una descripció de Google",
"metaimatge": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
"description": "Per a facebook",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"campanya": 1,
"enllaç profund": {
"auto": cert,
"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"
},
"geotarget": [
{
"location": "Canadà",
"enllaç": "https:\/\/google.ca"
},
{
"location": "Estats Units",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"language": "ca",
"link": "https:\/\/google.com"
},
{
"language": "fr",
"enllaç": "https:\/\/google.ca"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/url/add",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"url": "https:\/\/google.com",
"status": "privat",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"metatitle": "No Google",
"metadescription": "No és una descripció de Google",
"metaimatge": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
"description": "Per a facebook",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"campanya": 1,
"enllaç profund": {
"auto": cert,
"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"
},
"geotarget": [
{
"location": "Canadà",
"enllaç": "https:\/\/google.ca"
},
{
"location": "Estats Units",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"language": "ca",
"link": "https:\/\/google.com"
},
{
"language": "fr",
"enllaç": "https:\/\/google.ca"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/url/add',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"url": "https:\/\/google.com",
"status": "privat",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"metatitle": "No Google",
"metadescription": "No és una descripció de Google",
"metaimatge": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
"description": "Per a facebook",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"campanya": 1,
"enllaç profund": {
"auto": cert,
"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"
},
"geotarget": [
{
"location": "Canadà",
"enllaç": "https:\/\/google.ca"
},
{
"location": "Estats Units",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"language": "ca",
"link": "https:\/\/google.com"
},
{
"language": "fr",
"enllaç": "https:\/\/google.ca"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/url/add"
càrrega útil = {
"url": "https://google.com",
"status": "privat",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"metatitle": "No Google",
"metadescription": "No és una descripció de Google",
"metaimage": "https://www.mozilla.org/media/protocol/img/logos/firefox/browser/og.4ad05d4125a5.png",
"description": "Per a facebook",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"campanya": 1,
"enllaç profund": {
"auto": cert,
"poma": "https://apps.apple.com/us/app/google/id284815942",
"google": "https://play.google.com/store/apps/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=EUA"
},
"geotarget": [
{
"location": "Canadà",
"link": "https://google.ca"
},
{
"location": "Estats Units",
"link": "https://google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https://google.com"
},
{
"device": "Android",
"link": "https://google.com"
}
],
"languagetarget": [
{
"language": "ca",
"link": "https://google.com"
},
{
"language": "fr",
"link": "https://google.ca"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/url/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"url": "https:\/\/google.com",
"status": "privat",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"metatitle": "No Google",
"metadescription": "No és una descripció de Google",
"metaimatge": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
"description": "Per a facebook",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"campanya": 1,
"enllaç profund": {
"auto": cert,
"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"
},
"geotarget": [
{
"location": "Canadà",
"enllaç": "https:\/\/google.ca"
},
{
"location": "Estats Units",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"language": "ca",
"link": "https:\/\/google.com"
},
{
"language": "fr",
"enllaç": "https:\/\/google.ca"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"identificació": 3,
"shorturl": "https:\/\/urlkai.com\/google"
} https://urlkai.com/api/url/:id/update
For å oppdatere en lenke, må du sende en gyldig data i JSON via en PUT-forespørsel. Dataene må sendes som råteksten til forespørselen din som vist nedenfor. Eksemplet nedenfor viser alle parameterne du kan sende, men du er ikke pålagt å sende alle (se tabellen for mer info).
| Paràmetre | Beskrivelse |
|---|---|
| Adreça URL | (obligatori) URL llarg per escurçar. |
| costum | (opcional) Àlies personalitzat en lloc d'àlies aleatori. |
| tipus | (opcional) Tipus de redirecció [directe, marc, splash] |
| contrasenya | (opcional) Protecció amb contrasenya |
| domini | (opcional) Domini personalitzat |
| Caducitat | (opcional) Caducitat de l'exemple d'enllaç 2021-09-28 23:11:16 |
| Geotarget | (opcional) Dades de segmentació geogràfica |
| devicetarget | (opcional) Dades de segmentació per dispositiu |
| LanguageTarget | (opcional) Dades de segmentació per idioma |
| metatítol | (opcional) Meta títol |
| metadescripció | (opcional) Meta descripció |
| metaimatge | (opcional) Enllaçar a una imatge jpg o png |
| Píxels | (opcional) Array d'identificadors de píxels |
| canal | (opcional) Identificador del canal |
| campanya | (opcional) Identificador de campanya |
| enllaç profund | (opcional) Objecte que conté enllaços a la botiga d'aplicacions. Quan s'utilitza això, és important establir també l'orientació per dispositiu. |
curl --location --request PUT 'https://urlkai.com/api/url/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"url": "https:\/\/google.com",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"enllaç profund": {
"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"
},
"geotarget": [
{
"location": "Canadà",
"enllaç": "https:\/\/google.ca"
},
{
"location": "Estats Units",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/url/:id/update",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "POSAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"url": "https:\/\/google.com",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"enllaç profund": {
"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"
},
"geotarget": [
{
"location": "Canadà",
"enllaç": "https:\/\/google.ca"
},
{
"location": "Estats Units",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'PUT',
'url': 'https://urlkai.com/api/url/:id/update',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"url": "https:\/\/google.com",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"enllaç profund": {
"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"
},
"geotarget": [
{
"location": "Canadà",
"enllaç": "https:\/\/google.ca"
},
{
"location": "Estats Units",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/url/:id/update"
càrrega útil = {
"url": "https://google.com",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"enllaç profund": {
"poma": "https://apps.apple.com/us/app/google/id284815942",
"google": "https://play.google.com/store/apps/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=EUA"
},
"geotarget": [
{
"location": "Canadà",
"link": "https://google.ca"
},
{
"location": "Estats Units",
"link": "https://google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https://google.com"
},
{
"device": "Android",
"link": "https://google.com"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/url/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"url": "https:\/\/google.com",
"custom": "google",
"contrasenya": "mypass",
"caducitat": "2020-11-11 12:00:00",
"type": "esquitxada",
"píxels": [
1,
2,
3,
4
],
"canal": 1,
"enllaç profund": {
"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"
},
"geotarget": [
{
"location": "Canadà",
"enllaç": "https:\/\/google.ca"
},
{
"location": "Estats Units",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"device": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"paràmetres": [
{
"nom": "aff",
"valor": "3"
},
{
"dispositiu": "gtm_source",
"link": "api"
}
]
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"identificació": 3,
"short": "https:\/\/urlkai.com\/google"
} https://urlkai.com/api/url/:id/delete
For å slette en lenke, må du sende en SLETT-forespørsel.
curl --location --request DELETE 'https://urlkai.com/api/url/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/url/:id/delete",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "ESBORRAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'SUPRIMEIX',
'url': 'https://urlkai.com/api/url/:id/delete',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/url/:id/delete"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/url/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "L'enllaç s'ha suprimit correctament"
} https://urlkai.com/api/pixels?limit=2&page=1
Per obtenir els vostres codis de píxels mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).
| Paràmetre | Beskrivelse |
|---|---|
| límit | (opcional) Resultat de dades per pàgina |
| pàgina | (opcional) Sol·licitud de pàgina actual |
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "OBTENIR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'GET',
'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/pixels?limit=2&page=1"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": "0",
"dades": {
"resultat": 2,
"perpage": 2,
"pàgina actual": 1,
"pàgina següent": 1,
"maxpage": 1,
"píxels": [
{
"id": 1,
"type": "gtmpixel",
"name": "Píxel GTM",
"tag": "GA-123456789",
"data": "2020-11-10 18:00:00"
},
{
"identificació": 2,
"type": "twitterpixel",
"name": "píxel de Twitter",
"tag": "1234567",
"data": "2020-11-10 18:10:00"
}
]
}
} https://urlkai.com/api/pixel/add
Es pot crear un píxel amb aquest punt final. Heu d'enviar el tipus de píxel i l'etiqueta.
| Paràmetre | Beskrivelse |
|---|---|
| tipus | (obligatori) gtmpixel | Gapixel | fbpixel | AdwordsPixel | LinkedInPixel | Píxel de Twitter | AdrollPixel | quorapíxel | Pinterest | Bing | Xat de Snap | reddit | TikTok |
| nom | (obligatori) Nom personalitzat per al píxel |
| etiqueta | (obligatori) L'etiqueta del píxel |
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"type": "gtmpixel",
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/pixel/add",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "MISSATGE",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"type": "gtmpixel",
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'POST',
'url': 'https://urlkai.com/api/pixel/add',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"type": "gtmpixel",
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/pixel/add"
càrrega útil = {
"type": "gtmpixel",
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"type": "gtmpixel",
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"identificació": 1
} https://urlkai.com/api/pixel/:id/update
Per actualitzar un píxel, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud PUT. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).
| Paràmetre | Beskrivelse |
|---|---|
| nom | (opcional) Nom personalitzat per al píxel |
| etiqueta | (obligatori) L'etiqueta del píxel |
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}' $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "POSAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'PUT',
'url': 'https://urlkai.com/api/pixel/:id/update',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
cos: JSON.stringify({
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}),
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/pixel/:id/update"
càrrega útil = {
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
"name": "El meu GTM",
"tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "El píxel s'ha actualitzat correctament".
} https://urlkai.com/api/pixel/:id/delete
Per suprimir un píxel, heu d'enviar una sol·licitud DELETE.
curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ $curl = curl_init();
curl_setopt_array($curl, matriu(
CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
CURLOPT_RETURNTRANSFER => cert,
CURLOPT_MAXREDIRS = > 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => cert,
CURLOPT_CUSTOMREQUEST => "ESBORRAR",
CURLOPT_HTTPHEADER => [
"Autorització: Portador YOURAPIKEY",
"Tipus de contingut: aplicació/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ressò $response; var request = require('request');
var opcions = {
'method': 'SUPRIMEIX',
'url': 'https://urlkai.com/api/pixel/:id/delete',
'capçaleres': {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
},
};
sol·licitud(opcions, funció (error, resposta) {
if (error) llança un nou error (error);
console.log(resposta.cos);
}); Sol·licituds d'importació
url = "https://urlkai.com/api/pixel/:id/delete"
càrrega útil = {}
capçaleres = {
'Autorització': 'Portador YOURAPIKEY',
'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); {
"error": 0,
"message": "Pixel s'ha suprimit correctament".
}