Getting Started Authentication Rate Limit Response Handling
Compte
Domaines de marque
Superpositions CTA
Campagnes
Canaux
Éclaboussure personnalisée
Files
Liens
Pixels
QR Codes

API Reference for Developers

Getting Started

An API key is required for requests to be processed by the system. Once a user registers, an API key is automatically generated for this user. The API key must be sent with each request (see full example below). If the API key is not sent or is expired, there will be an error. Please make sure to keep your API key secret to prevent abuse.

Authentication

To authenticate with the API system, you need to send your API key as an authorization token with each request. You can see sample code below.

cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;
curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/account »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « POST »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
));

$response = curl_exec($curl) ; 
var request = require('request') ;
options var = {
    'method' : 'POST',
    'url' : 'https://urlkai.com/api/account',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : ''
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/account »
charge utile = {}
en-têtes = {
  'Autorisation' : 'Porteur YOURAPIKEY',
  'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/account ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Rate Limit

Our API has a rate limiter to safeguard against spike in requests to maximize its stability. Our rate limiter is currently caped at 30 requests per 1 minute. Please note that the rate might change according to the subscribed plan.

Several headers will be sent alongside the response and these can be examined to determine various information about the request.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Response Handling

All API response are returned in JSON format by default. To convert this into usable data, the appropriate function will need to be used according to the language. In PHP, the function json_decode() can be used to convert the data to either an object (default) or an array (set the second parameter to true). It is very important to check the error key as that provides information on whether there was an error or not. You can also check the header code.

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

Compte

Obtenir un compte
GET https://urlkai.com/api/account

Pour obtenir des informations sur le compte, vous pouvez envoyer une demande à ce point de terminaison qui renverra des données sur le compte.

cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/account »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/account',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/account »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/account ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « données » : {
        « id » : 1,
        « email » : » [email protected] ",
        « username » : « sampleuser »,
        « avatar » : « https :\/\/domain.com\/content\/avatar.png »,
        « status » : « pro »,
        « expire » : « 2022-11-15 15:00:00 »,
        « registered » : « 2020-11-10 18:01:43 »
    }
}
Mettre à jour le compte
PUT https://urlkai.com/api/account/update

Pour mettre à jour les informations du compte, vous pouvez envoyer une demande à ce point de terminaison qui mettra à jour les données du compte.

cURL PHP Node.js Python C# 
curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « email » : » [email protected] ",
    « password » : « nouveaumot de passe »
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/account/update »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « METTRE »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « email » : » [email protected] ",
	    « password » : « nouveaumot de passe »
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'PUT',
    'url' : 'https://urlkai.com/api/account/update',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « email » : » [email protected] ",
    « password » : « nouveaumot de passe »
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/account/update »
charge utile = {
    « email » : » [email protected] ",
    « password » : « nouveaumot de passe »
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« PUT », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Put, « https://urlkai.com/api/account/update ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « email » : » [email protected] ",
    « password » : « nouveaumot de passe »
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « Le compte a été mis à jour avec succès. »
}

Domaines de marque

Liste des domaines de marque
GET https://urlkai.com/api/domains?limit=2&page=1

Pour obtenir vos domaines de marque via l’API, vous pouvez utiliser ce point de terminaison. Vous pouvez également filtrer les données (voir le tableau pour plus d’informations).

Paramètre Description
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/domains?limit=2&page=1 »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/domains?limit=2&page=1',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/domains?limit=2&page=1 »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/domains?limit=2&page=1 ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : « 0 »,
    « données » : {
        « résultat » : 2,
        « perpage » : 2,
        « currentpage » : 1,
        « page suivante » : 1,
        « maxpage » : 1,
        « domaines » : [
            {
                « id » : 1,
                « domain » : « https :\/\/domain1.com »,
                « redirectroot » : « https :\/\/rootdomain.com »,
                « redirect404 » : « https :\/\/rootdomain.com\/404 »
            },
            {
                « id » : 2,
                « domain » : « https :\/\/domain2.com »,
                « redirectroot » : « https :\/\/rootdomain2.com »,
                « redirect404 » : « https :\/\/rootdomain2.com\/404 »
            }
        ]
    }
}
Créer un domaine de marque
POST https://urlkai.com/api/domain/add

Un domaine peut être ajouté à l’aide de ce point de terminaison. Veuillez vous assurer que le domaine est correctement pointé vers notre serveur.

Paramètre Description
domaine (obligatoire) Domaine de marque incluant http ou https
redirectroot (facultatif) Redirection racine lorsque quelqu’un visite votre domaine
redirect404 (facultatif) Redirection 404 personnalisée
cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « domain » : « https :\/\/domain1.com »,
    « redirectroot » : « https :\/\/rootdomain.com »,
    « redirect404 » : « https :\/\/rootdomain.com\/404 »
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/domain/add »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « POST »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « domain » : « https :\/\/domain1.com »,
	    « redirectroot » : « https :\/\/rootdomain.com »,
	    « redirect404 » : « https :\/\/rootdomain.com\/404 »
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'POST',
    'url' : 'https://urlkai.com/api/domain/add',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « domain » : « https :\/\/domain1.com »,
    « redirectroot » : « https :\/\/rootdomain.com »,
    « redirect404 » : « https :\/\/rootdomain.com\/404 »
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/domain/add »
charge utile = {
    « domain » : « https://domain1.com »,
    « redirectroot » : « https://rootdomain.com »,
    « redirect404 » : « https://rootdomain.com/404 »
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« POST », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Post, « https://urlkai.com/api/domain/add ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « domain » : « https :\/\/domain1.com »,
    « redirectroot » : « https :\/\/rootdomain.com »,
    « redirect404 » : « https :\/\/rootdomain.com\/404 »
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « id » : 1
}
Update Domain
PUT https://urlkai.com/api/domain/:id/update

Pour mettre à jour un domaine de marque, vous devez envoyer des données valides en JSON via une requête PUT. Les données doivent être envoyées dans le corps brut de votre demande, comme indiqué ci-dessous. L’exemple ci-dessous montre tous les paramètres que vous pouvez envoyer, mais vous n’êtes pas obligé de tous les envoyer (voir le tableau pour plus d’informations).

Paramètre Description
redirectroot (facultatif) Redirection racine lorsque quelqu’un visite votre domaine
redirect404 (facultatif) Redirection 404 personnalisée
cURL PHP Node.js Python C# 
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « redirectroot » : « https :\/\/rootdomain-new.com »,
    « redirect404 » : « https :\/\/rootdomain-new.com\/404 »
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/domain/:id/update »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « METTRE »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « redirectroot » : « https :\/\/rootdomain-new.com »,
	    « redirect404 » : « https :\/\/rootdomain-new.com\/404 »
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'PUT',
    'url' : 'https://urlkai.com/api/domain/:id/update',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « redirectroot » : « https :\/\/rootdomain-new.com »,
    « redirect404 » : « https :\/\/rootdomain-new.com\/404 »
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/domain/:id/update »
charge utile = {
    « redirectroot » : « https://rootdomain-new.com »,
    « redirect404 » : « https://rootdomain-new.com/404 »
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« PUT », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Put, « https://urlkai.com/api/domain/:id/update ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « redirectroot » : « https :\/\/rootdomain-new.com »,
    « redirect404 » : « https :\/\/rootdomain-new.com\/404 »
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « Le domaine a été mis à jour avec succès. »
}
Supprimer le domaine
DELETE https://urlkai.com/api/domain/:id/delete

Pour supprimer un domaine, vous devez envoyer une demande DELETE.

cURL PHP Node.js Python C# 
curl --location --request SUPPRIMER 'https://urlkai.com/api/domain/:id/delete' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/domain/:id/delete »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « SUPPRIMER »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'SUPPRIMER',
    'url' : 'https://urlkai.com/api/domain/:id/delete',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/domain/:id/delete »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« DELETE », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Delete, « https://urlkai.com/api/domain/:id/delete ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « Le domaine a été supprimé avec succès. »
}

Superpositions CTA

Liste des superpositions CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

Pour obtenir des superpositions de cta via l’API, vous pouvez utiliser ce point de terminaison. Vous pouvez également filtrer les données (voir le tableau pour plus d’informations).

Paramètre Description
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/overlay?limit=2&page=1 »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/overlay?limit=2&page=1',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/overlay?limit=2&page=1 »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/overlay?limit=2&page=1 ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : « 0 »,
    « données » : {
        « résultat » : 2,
        « perpage » : 2,
        « currentpage » : 1,
        « page suivante » : 1,
        « maxpage » : 1,
        « CTA » : [
            {
                « id » : 1,
                « type » : « message »,
                « name » : « Promo Produit 1 »,
                « date » : « 2020-11-10 18:00:00 »
            },
            {
                « id » : 2,
                « type » : « contact »,
                « name » : « Page de contact »,
                « date » : « 2020-11-10 18:10:00 »
            }
        ]
    }
}

Campagnes

Campagnes de liste
GET https://urlkai.com/api/campaigns?limit=2&page=1

Pour obtenir vos campagnes via l’API, vous pouvez utiliser ce point de terminaison. Vous pouvez également filtrer les données (voir le tableau pour plus d’informations).

Paramètre Description
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/campaigns?limit=2&page=1 »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/campaigns?limit=2&page=1 »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/campaigns?limit=2&page=1 ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : « 0 »,
    « données » : {
        « résultat » : 2,
        « perpage » : 2,
        « currentpage » : 1,
        « page suivante » : 1,
        « maxpage » : 1,
        « campagnes » : [
            {
                « id » : 1,
                « name » : « Exemple de campagne »,
                « public » : faux,
                « rotator » : faux,
                « list » : « https :\/\/domain.com\/u\/admin\/list-1 »
            },
            {
                « id » : 2,
                « domain » : « Campagne Facebook »,
                « public » : vrai,
                « rotator » : « https :\/\/domain.com\/r\/test »,
                « list » : « https :\/\/domain.com\/u\/admin\/test-2 »
            }
        ]
    }
}
Create a Campaign
POST https://urlkai.com/api/campaign/add

Une campagne peut être ajoutée à l’aide de ce point de terminaison.

Paramètre Description
nom (facultatif) Nom de la campagne
limace (facultatif) Limace du rotateur
public (facultatif) Accès
cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « name » : « Nouvelle campagne »,
    « slug » : « nouvelle-campagne »,
    « public » : vrai
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/campaign/add »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « POST »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « name » : « Nouvelle campagne »,
	    « slug » : « nouvelle-campagne »,
	    « public » : vrai
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'POST',
    'url' : 'https://urlkai.com/api/campaign/add',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « name » : « Nouvelle campagne »,
    « slug » : « nouvelle-campagne »,
    « public » : vrai
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/campaign/add »
charge utile = {
    « name » : « Nouvelle campagne »,
    « slug » : « nouvelle-campagne »,
    « public » : vrai
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« POST », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Post, « https://urlkai.com/api/campaign/add ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « name » : « Nouvelle campagne »,
    « slug » : « nouvelle-campagne »,
    « public » : vrai
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « id » : 3,
    « domain » : « Nouvelle campagne »,
    « public » : vrai,
    « rotator » : « https :\/\/domain.com\/r\/new-campaign »,
    « list » : « https :\/\/domain.com\/u\/admin\/new-campaign-3 »
}
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Un lien court peut être attribué à une campagne à l’aide de ce point de terminaison. Le point de terminaison nécessite l’ID de la campagne et l’ID du lien court.

cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/campaign/:campaignid/assign/:linkid »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « POST »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'POST',
    'url' : 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/campaign/:campaignid/assign/:linkid »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« POST », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Post, « https://urlkai.com/api/campaign/:campaignid/assign/:linkid ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « Lien ajouté avec succès à la campagne. »
}
Update Campaign
PUT https://urlkai.com/api/campaign/:id/update

Pour mettre à jour une campagne, vous devez envoyer des données valides en JSON via une requête PUT. Les données doivent être envoyées dans le corps brut de votre demande, comme indiqué ci-dessous. L’exemple ci-dessous montre tous les paramètres que vous pouvez envoyer, mais vous n’êtes pas obligé de tous les envoyer (voir le tableau pour plus d’informations).

Paramètre Description
nom (obligatoire) Nom de la campagne
limace (facultatif) Limace du rotateur
public (facultatif) Accès
cURL PHP Node.js Python C# 
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « name » : « Campagne Twitter »,
    « slug » : « campagne-twitter »,
    « public » : vrai
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/campaign/:id/update »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « METTRE »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « name » : « Campagne Twitter »,
	    « slug » : « campagne-twitter »,
	    « public » : vrai
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'PUT',
    'url' : 'https://urlkai.com/api/campaign/:id/update',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « name » : « Campagne Twitter »,
    « slug » : « campagne-twitter »,
    « public » : vrai
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/campaign/:id/update »
charge utile = {
    « name » : « Campagne Twitter »,
    « slug » : « campagne-twitter »,
    « public » : vrai
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« PUT », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Put, « https://urlkai.com/api/campaign/:id/update ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « name » : « Campagne Twitter »,
    « slug » : « campagne-twitter »,
    « public » : vrai
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « id » : 3,
    « domain » : « Campagne Twitter »,
    « public » : vrai,
    « rotator » : « https :\/\/domain.com\/r\/twitter-campaign »,
    « list » : « https :\/\/domain.com\/u\/admin\/twitter-campaign-3 »
}
Supprimer la campagne
DELETE https://urlkai.com/api/campaign/:id/delete

Pour supprimer une campagne, vous devez envoyer une demande DELETE.

cURL PHP Node.js Python C# 
curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/campaign/:id/delete »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « SUPPRIMER »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'SUPPRIMER',
    'url' : 'https://urlkai.com/api/campaign/:id/delete',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/campaign/:id/delete »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« DELETE », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Delete, « https://urlkai.com/api/campaign/:id/delete ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « La campagne a été supprimée avec succès. »
}

Canaux

Liste des chaînes
GET https://urlkai.com/api/channels?limit=2&page=1

Pour obtenir vos chaînes via l’API, vous pouvez utiliser ce point de terminaison. Vous pouvez également filtrer les données (voir le tableau pour plus d’informations).

Paramètre Description
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/channels?limit=2&page=1 »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/channels?limit=2&page=1',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/channels?limit=2&page=1 »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/channels?limit=2&page=1 ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : « 0 »,
    « données » : {
        « résultat » : 2,
        « perpage » : 2,
        « currentpage » : 1,
        « page suivante » : 1,
        « maxpage » : 1,
        « chaînes » : [
            {
                « id » : 1,
                « name » : « Canal 1 »,
                « description » : « Description du canal 1 »,
                « color » : « #000000 »,
                « étoilé » : vrai
            },
            {
                « id » : 2,
                « name » : « Canal 2 »,
                « description » : « Description du canal 2 »,
                « color » : « #FF0000 »,
                « starred » : faux
            }
        ]
    }
}
Liste des éléments de chaîne
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Pour obtenir des éléments dans un canal sélectionné via l’API, vous pouvez utiliser ce point de terminaison. Vous pouvez également filtrer les données (voir le tableau pour plus d’informations).

Paramètre Description
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/channel/:id?limit=1&page=1 »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/channel/:id?limit=1&page=1 »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/channel/:id?limit=1&page=1 ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : « 0 »,
    « données » : {
        « résultat » : 2,
        « perpage » : 2,
        « currentpage » : 1,
        « page suivante » : 1,
        « maxpage » : 1,
        « items » : [
            {
                « type » : « liens »,
                « id » : 1,
                « title » : « Mon exemple de lien »,
                « preview » : « https :\/\/google.com »,
                « link » : « https :\/\/urlkai.com\/google »,
                « date » : « 2022-05-12 »
            },
            {
                « type » : « bio »,
                « id » : 1,
                « title » : « Mon échantillon de biographie »,
                « preview » : « https :\/\/urlkai.com\/mybio »,
                « link » : « https :\/\/urlkai.com\/mybio »,
                « date » : « 2022-06-01 »
            }
        ]
    }
}
Créer une chaîne
POST https://urlkai.com/api/channel/add

Un canal peut être ajouté à l’aide de ce point de terminaison.

Paramètre Description
nom (obligatoire) Nom de la chaîne
description (facultatif) Description de la chaîne
Couleur (facultatif) Couleur de l’insigne de canal (HEX)
Joué (facultatif) Marquez la chaîne d’une étoile ou non (vrai ou faux)
cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « name » : « Nouvelle chaîne »,
    « description » : « Ma nouvelle chaîne »,
    « color » : « #000000 »,
    « étoilé » : vrai
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/channel/add »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « POST »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « name » : « Nouvelle chaîne »,
	    « description » : « Ma nouvelle chaîne »,
	    « color » : « #000000 »,
	    « étoilé » : vrai
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'POST',
    'url' : 'https://urlkai.com/api/channel/add',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « name » : « Nouvelle chaîne »,
    « description » : « Ma nouvelle chaîne »,
    « color » : « #000000 »,
    « étoilé » : vrai
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/channel/add »
charge utile = {
    « name » : « Nouvelle chaîne »,
    « description » : « Ma nouvelle chaîne »,
    « color » : « #000000 »,
    « étoilé » : vrai
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« POST », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Post, « https://urlkai.com/api/channel/add ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « name » : « Nouvelle chaîne »,
    « description » : « Ma nouvelle chaîne »,
    « color » : « #000000 »,
    « étoilé » : vrai
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « id » : 3,
    « name » : « Nouvelle chaîne »,
    « description » : « Ma nouvelle chaîne »,
    « color » : « #000000 »,
    « étoilé » : vrai
}
Attribuer un élément à un canal
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Un élément peut être attribué à n’importe quel canal en envoyant une demande avec l’identifiant du canal, le type d’élément (liens, biographie ou QR) et l’identifiant de l’élément.

Paramètre Description
:channelid (obligatoire) ID de la chaîne
:type (obligatoire) liens ou biographie ou QR
:itemid (obligatoire) ID de l’objet
cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/channel/:channelid/assign/:type/:itemid »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « POST »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'POST',
    'url' : 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/channel/:channelid/assign/:type/:itemid »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« POST », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Post, « https://urlkai.com/api/channel/:channelid/assign/:type/:itemid ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « L’élément a été ajouté avec succès au canal. »
}
Mettre à jour la chaîne
PUT https://urlkai.com/api/channel/:id/update

Pour mettre à jour un canal, vous devez envoyer des données valides en JSON via une requête PUT. Les données doivent être envoyées dans le corps brut de votre demande, comme indiqué ci-dessous. L’exemple ci-dessous montre tous les paramètres que vous pouvez envoyer, mais vous n’êtes pas obligé de tous les envoyer (voir le tableau pour plus d’informations).

Paramètre Description
nom (facultatif) Nom de la chaîne
description (facultatif) Description de la chaîne
Couleur (facultatif) Couleur de l’insigne de canal (HEX)
Joué (facultatif) Marquez la chaîne d’une étoile ou non (vrai ou faux)
cURL PHP Node.js Python C# 
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « name » : « Acme Corp »,
    « description » : « canal pour les articles pour Acme Corp »,
    « color » : « #FFFFFF »,
    « starred » : faux
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/channel/:id/update »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « METTRE »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « name » : « Acme Corp »,
	    « description » : « canal pour les articles pour Acme Corp »,
	    « color » : « #FFFFFF »,
	    « starred » : faux
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'PUT',
    'url' : 'https://urlkai.com/api/channel/:id/update',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « name » : « Acme Corp »,
    « description » : « canal pour les articles pour Acme Corp »,
    « color » : « #FFFFFF »,
    « starred » : faux
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/channel/:id/update »
charge utile = {
    « name » : « Acme Corp »,
    « description » : « canal pour les articles pour Acme Corp »,
    « color » : « #FFFFFF »,
    « starred » : faux
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« PUT », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Put, « https://urlkai.com/api/channel/:id/update ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « name » : « Acme Corp »,
    « description » : « canal pour les articles pour Acme Corp »,
    « color » : « #FFFFFF »,
    « starred » : faux
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « La chaîne a été mise à jour avec succès. »
}
Supprimer la chaîne
DELETE https://urlkai.com/api/channel/:id/delete

Pour supprimer un canal, vous devez envoyer une demande DELETE. Tous les éléments seront également désattribués.

cURL PHP Node.js Python C# 
curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/channel/:id/delete »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « SUPPRIMER »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'SUPPRIMER',
    'url' : 'https://urlkai.com/api/channel/:id/delete',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/channel/:id/delete »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« DELETE », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Delete, « https://urlkai.com/api/channel/:id/delete ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « La chaîne a été supprimée avec succès. »
}

Éclaboussure personnalisée

Liste Custom Splash
GET https://urlkai.com/api/splash?limit=2&page=1

Pour obtenir des pages d’accueil personnalisées via l’API, vous pouvez utiliser ce point de terminaison. Vous pouvez également filtrer les données (voir le tableau pour plus d’informations).

Paramètre Description
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/splash?limit=2&page=1 »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/splash?limit=2&page=1',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/splash?limit=2&page=1 »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/splash?limit=2&page=1 ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : « 0 »,
    « données » : {
        « résultat » : 2,
        « perpage » : 2,
        « currentpage » : 1,
        « page suivante » : 1,
        « maxpage » : 1,
        « éclaboussure » : [
            {
                « id » : 1,
                « name » : « Promo Produit 1 »,
                « date » : « 2020-11-10 18:00:00 »
            },
            {
                « id » : 2,
                « name » : « Promo Produit 2 »,
                « date » : « 2020-11-10 18:10:00 »
            }
        ]
    }
}

Files

List Files
GET https://urlkai.com/api/files?limit=2&page=1

Get all of your files. You can also search by name.

Paramètre Description
nom (optional) Search for a file by name
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

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

$response = curl_exec($curl);

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

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Server response
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/VugxJ",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/lFIoi",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/Mmirm",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
Upload a file
POST https://urlkai.com/api/files/upload/:filename?name=My+File

Upload a file by sending the binary data as the post body. You need to send the file name including the extension instead of :filename in the url (e.g. brandkit.zip). You can set options by sending the following parameters.

Paramètre Description
nom (optional) File name
coutume (facultatif) Alias personnalisé au lieu d’alias aléatoires.
domaine (facultatif) Domaine personnalisé
mot de passe (facultatif) Protection par mot de passe
expiration (optional) Expiration for the download example 2021-09-28
maxdownloads (optional) Maximum number of downloads
cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
$curl = curl_init();

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

$response = curl_exec($curl);

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

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

Liens

Pixels

Liste des pixels
GET https://urlkai.com/api/pixels?limit=2&page=1

Pour obtenir vos codes de pixels via l’API, vous pouvez utiliser ce point de terminaison. Vous pouvez également filtrer les données (voir le tableau pour plus d’informations).

Paramètre Description
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/pixels?limit=2&page=1 »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/pixels?limit=2&page=1',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/pixels?limit=2&page=1 »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/pixels?limit=2&page=1 ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : « 0 »,
    « données » : {
        « résultat » : 2,
        « perpage » : 2,
        « currentpage » : 1,
        « page suivante » : 1,
        « maxpage » : 1,
        « pixels » : [
            {
                « id » : 1,
                « type » : « gtmpixel »,
                « name » : « GTM Pixel »,
                « tag » : « GA-123456789 »,
                « date » : « 2020-11-10 18:00:00 »
            },
            {
                « id » : 2,
                « type » : « twitterpixel »,
                « name » : « Pixel Twitter »,
                « tag » : « 1234567 »,
                « date » : « 2020-11-10 18:10:00 »
            }
        ]
    }
}
Créer un pixel
POST https://urlkai.com/api/pixel/add

Un pixel peut être créé à l’aide de ce point de terminaison. Vous devez envoyer le type de pixel et la balise.

Paramètre Description
type (obligatoire) gtmpixel | gapixel | fbpixel | AdWordsPixel | Linkedinpixel | Pixel Twitter | Adrollpixel | QuoraPixel | Pinterest | Bing | Instantané | Reddit | Tiktok
nom (obligatoire) Nom personnalisé de votre pixel
étiquette (obligatoire) La balise du pixel
cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « type » : « gtmpixel »,
    « name » : « Mon GTM »,
    « tag » : « GTM-ABCDE »
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/pixel/add »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « POST »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « type » : « gtmpixel »,
	    « name » : « Mon GTM »,
	    « tag » : « GTM-ABCDE »
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'POST',
    'url' : 'https://urlkai.com/api/pixel/add',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « type » : « gtmpixel »,
    « name » : « Mon GTM »,
    « tag » : « GTM-ABCDE »
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/pixel/add »
charge utile = {
    « type » : « gtmpixel »,
    « name » : « Mon GTM »,
    « tag » : « GTM-ABCDE »
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« POST », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Post, « https://urlkai.com/api/pixel/add ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « type » : « gtmpixel »,
    « name » : « Mon GTM »,
    « tag » : « GTM-ABCDE »
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « id » : 1
}
Update Pixel
PUT https://urlkai.com/api/pixel/:id/update

Pour mettre à jour un pixel, vous devez envoyer des données valides en JSON via une requête PUT. Les données doivent être envoyées dans le corps brut de votre demande, comme indiqué ci-dessous. L’exemple ci-dessous montre tous les paramètres que vous pouvez envoyer, mais vous n’êtes pas obligé de tous les envoyer (voir le tableau pour plus d’informations).

Paramètre Description
nom (facultatif) Nom personnalisé de votre pixel
étiquette (obligatoire) La balise du pixel
cURL PHP Node.js Python C# 
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « name » : « Mon GTM »,
    « tag » : « GTM-ABCDE »
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/pixel/:id/update »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « METTRE »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « name » : « Mon GTM »,
	    « tag » : « GTM-ABCDE »
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'PUT',
    'url' : 'https://urlkai.com/api/pixel/:id/update',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « name » : « Mon GTM »,
    « tag » : « GTM-ABCDE »
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/pixel/:id/update »
charge utile = {
    « name » : « Mon GTM »,
    « tag » : « GTM-ABCDE »
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« PUT », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Put, « https://urlkai.com/api/pixel/:id/update ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « name » : « Mon GTM »,
    « tag » : « GTM-ABCDE »
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « Le pixel a été mis à jour avec succès. »
}
Supprimer le pixel
DELETE https://urlkai.com/api/pixel/:id/delete

Pour supprimer un pixel, vous devez envoyer une requête DELETE.

cURL PHP Node.js Python C# 
curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/pixel/:id/delete »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « SUPPRIMER »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'SUPPRIMER',
    'url' : 'https://urlkai.com/api/pixel/:id/delete',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/pixel/:id/delete »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« DELETE », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Delete, « https://urlkai.com/api/pixel/:id/delete ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « Le pixel a été supprimé avec succès. »
}

QR Codes

Liste des codes QR
GET https://urlkai.com/api/qr?limit=2&page=1

Pour obtenir vos codes QR via l’API, vous pouvez utiliser ce point de terminaison. Vous pouvez également filtrer les données (voir le tableau pour plus d’informations).

Paramètre Description
limite (facultatif) Résultat des données par page
page (facultatif) Demande de page actuelle
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/qr?limit=2&page=1 »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/qr?limit=2&page=1',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/qr?limit=2&page=1 »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/qr?limit=2&page=1 ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : « 0 »,
    « données » : {
        « résultat » : 2,
        « perpage » : 2,
        « currentpage » : 1,
        « page suivante » : 1,
        « maxpage » : 1,
        « QRS » : [
            {
                « id » : 2,
                « link » : « https :\/\/urlkai.com\/qr\/a2d5e »,
                « scans » : 0,
                « name » : « Google »,
                « date » : « 2020-11-10 18:01:43 »
            },
            {
                « id » : 1,
                « link » : « https :\/\/urlkai.com\/qr\/b9edfe »,
                « scans » : 5,
                « name » : « Google Canada »,
                « date » : « 2020-11-10 18:00:25 »
            }
        ]
    }
}
Obtenez un seul code QR
GET https://urlkai.com/api/qr/:id

Pour obtenir les détails d’un seul code QR via l’API, vous pouvez utiliser ce point de terminaison.

cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/qr/:id »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « OBTENIR »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'GET',
    'url' : 'https://urlkai.com/api/qr/:id',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/qr/:id »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« GET », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Get, « https://urlkai.com/api/qr/:id ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « détails » : {
        « id » : 1,
        « link » : « https :\/\/urlkai.com\/qr\/b9edfe »,
        « scans » : 5,
        « name » : « Google Canada »,
        « date » : « 2020-11-10 18:00:25 »
    },
    « données » : {
        « clics » : 1,
        « uniqueClicks » : 1,
        « topCountries » : {
            « Inconnu » : « 1 »
        },
        « topReferrers » : {
            « Direct, email et autres » : « 1 »
        },
        « topBrowsers » : {
            « Chrome » : « 1 »
        },
        « topOs » : {
            « Windows 10 » : « 1 »
        },
        « socialCount » : {
            « Facebook » : 0,
            « twitter » : 0,
            « Instagram » : 0
        }
    }
}
Créer un QR Code
POST https://urlkai.com/api/qr/add

Pour créer un QR Code, vous devez envoyer des données valides en JSON via une requête POST. Les données doivent être envoyées dans le corps brut de votre demande, comme indiqué ci-dessous. L’exemple ci-dessous montre tous les paramètres que vous pouvez envoyer, mais vous n’êtes pas obligé de tous les envoyer (voir le tableau pour plus d’informations).

Paramètre Description
type Texte (obligatoire) | vcard | lien | Courriel | Téléphone | Par SMS | Wifi
données (obligatoire) Les données doivent être intégrées dans le code QR. Les données peuvent être des chaînes ou des tableaux selon le type
arrière-plan (facultatif) Couleur RVB, par exemple rgb(255,255,255)
premier plan (facultatif) Couleur RVB, par exemple rgb(0,0,0)
logo (facultatif) Chemin d’accès au logo png ou jpg
nom (facultatif) Nom du QR Code
cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « type » : « lien »,
    « data » : « https :\/\/google.com »,
    « background » : « rgb(255,255,255) »,
    « foreground » : « rgb(0,0,0) »,
    « logo » : « https :\/\/site.com\/logo.png »,
    « name » : « API de code QR »
}' 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/qr/add »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « POST »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « type » : « lien »,
	    « data » : « https :\/\/google.com »,
	    « background » : « rgb(255,255,255) »,
	    « foreground » : « rgb(0,0,0) »,
	    « logo » : « https :\/\/site.com\/logo.png »,
	    « name » : « API de code QR »
	}',
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'POST',
    'url' : 'https://urlkai.com/api/qr/add',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « type » : « lien »,
    « data » : « https :\/\/google.com »,
    « background » : « rgb(255,255,255) »,
    « foreground » : « rgb(0,0,0) »,
    « logo » : « https :\/\/site.com\/logo.png »,
    « name » : « API de code QR »
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/qr/add »
charge utile = {
    « type » : « lien »,
    « data » : « https://google.com »,
    « background » : « rgb(255,255,255) »,
    « foreground » : « rgb(0,0,0) »,
    « logo » : « https://site.com/logo.png »,
    « name » : « API de code QR »
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« POST », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Post, « https://urlkai.com/api/qr/add ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « type » : « lien »,
    « data » : « https :\/\/google.com »,
    « background » : « rgb(255,255,255) »,
    « foreground » : « rgb(0,0,0) »,
    « logo » : « https :\/\/site.com\/logo.png »,
    « name » : « API de code QR »
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « id » : 3,
    « link » : « https :\/\/urlkai.com\/QR\/A58F79 »
}
Mettre à jour le code QR
PUT https://urlkai.com/api/qr/:id/update

Pour mettre à jour un QR Code, vous devez envoyer des données valides en JSON via une requête PUT. Les données doivent être envoyées dans le corps brut de votre demande, comme indiqué ci-dessous. L’exemple ci-dessous montre tous les paramètres que vous pouvez envoyer, mais vous n’êtes pas obligé de tous les envoyer (voir le tableau pour plus d’informations).

Paramètre Description
données (obligatoire) Les données doivent être intégrées dans le code QR. Les données peuvent être des chaînes ou des tableaux selon le type
arrière-plan (facultatif) Couleur RVB, par exemple rgb(255,255,255)
premier plan (facultatif) Couleur RVB, par exemple rgb(0,0,0)
logo (facultatif) Chemin d’accès au logo png ou jpg
cURL PHP Node.js Python C# 
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \
--data-raw '{
    « type » : « lien »,
    « data » : « 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, array(
    CURLOPT_URL => « https://urlkai.com/api/qr/:id/update »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « METTRE »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    « type » : « lien »,
	    « data » : « 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) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'PUT',
    'url' : 'https://urlkai.com/api/qr/:id/update',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    corps : JSON.stringify({
    « type » : « lien »,
    « data » : « https :\/\/google.com »,
    « background » : « rgb(255,255,255) »,
    « foreground » : « rgb(0,0,0) »,
    « logo » : « https :\/\/site.com\/logo.png »
}),
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/qr/:id/update »
charge utile = {
    « type » : « lien »,
    « data » : « https://google.com »,
    « background » : « rgb(255,255,255) »,
    « foreground » : « rgb(0,0,0) »,
    « logo » : « https://site.com/logo.png »
}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« PUT », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Put, « https://urlkai.com/api/qr/:id/update ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent("{
    « type » : « lien »,
    « data » : « https :\/\/google.com »,
    « background » : « rgb(255,255,255) »,
    « foreground » : « rgb(0,0,0) »,
    « logo » : « https :\/\/site.com\/logo.png »
} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « Le QR a été mis à jour avec succès. »
}
Supprimer un code QR
DELETE https://urlkai.com/api/qr/:id/delete

Pour supprimer un code QR, vous devez envoyer une demande DELETE.

cURL PHP Node.js Python C# 
curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Autorisation : Porteur YOURAPIKEY' \
--header 'Type-de-contenu : application/json' \ 
$curl = curl_init() ;

curl_setopt_array($curl, array(
    CURLOPT_URL => « https://urlkai.com/api/qr/:id/delete »,
    CURLOPT_RETURNTRANSFER => vrai,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => vrai,
    CURLOPT_CUSTOMREQUEST => « SUPPRIMER »,
    CURLOPT_HTTPHEADER => [
        « Autorisation : Porteur YOURAPIKEY »,
        « Type-de-contenu : application/json »,
    ],
    
));

$response = curl_exec($curl) ;

curl_close($curl) ;
écho $response ; 
var request = require('request') ;
options var = {
    'method' : 'SUPPRIMER',
    'url' : 'https://urlkai.com/api/qr/:id/delete',
    'en-têtes' : {
        'Autorisation' : 'Porteur YOURAPIKEY',
        'content-Type' : 'application/json'
    },
    
};
request(options, function (erreur, réponse) {
    if (error) throw new Error(error) ;
    console.log(response.body) ;
}); 
Demandes d’importation
url = « https://urlkai.com/api/qr/:id/delete »
charge utile = {}
en-têtes = {
    'Autorisation' : 'Porteur YOURAPIKEY',
    'content-Type' : 'application/json'
}
réponse = requests.request(« DELETE », url, headers=headers, json=payload)
print(réponse.texte) 
var client = nouveau HttpClient() ;
var request = new HttpRequestMessage(HttpMethod.Delete, « https://urlkai.com/api/qr/:id/delete ») ;
demander. headers.add(« autorisation », « porteur YOURAPIKEY ») ;
var content = new StringContent(« {} », System.Text.Encoding.UTF8, « application/json ») ;
demander. Contenu = contenu ;
var response = attendre le client. SendAsync(demande) ;
réponse. EnsureSuccessStatusCode() ;
Console.WriteLine(attendre la réponse. Content.ReadAsStringAsync()) ;
Server response
{
    « error » : 0,
    « message » : « Le code QR a été supprimé avec succès. »
}