Referência de API para desenvolvedores

Começando

Uma chave de API é necessária para que as solicitações sejam processadas pelo sistema. Depois que mmm usuário se registra, uma chave de API é gerada automaticamente para esse usuário. A chave de API deve ser enviada com cada solicitação (veja o exemplo completo abaixo). Se a chave de API não for enviada ou tiver expirado, ocorrerá mmm erro. Certifique-se de manter sua chave de API em segredo para evitar abusos.

Autenticação

Para autenticar com o sistema de API, você precisa enviar sua chave de API como mmm token de autorização com cada solicitação. Você pode ver o código de exemplo abaixo.

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PUBLICAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
));

$response = curl_exec($curl); 
var solicitud = require('solicitud');
opciones var = {
    'método': 'POST',
    'url': 'https://urlkai.com/api/account',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    Cuerpo: ''
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/account"
carga útil = {}
encabezados = {
  «Autorización»: «Portador YOURAPIKEY»,
  'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Taxa limite

Nossa API tem mmm limitador de taxa para proteger contra picos de solicitações para maximizar sua estabilidade. Nosso limitador de taxa está limitado a 30 solicitações por 1 minuto. Tenga en cuenta que la tarifa puede cambiar según el plan suscrito.

Vários cabeçalhos serão enviados juntamente com a resposta e estes podem ser examinados para determinar várias informações sobre a solicitação.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Tratamento de respostas

Todas as respostas da API são retornadas no formato JSON por padrão. Para converter isso em dados utilizáveis, a função apropriada precisará ser usada de acordo com o idioma. Em PHP, a função json_decode() pode ser usada para converter os dados em mmm objeto (padrão) ou mmm array (defina o segundo parâmetro como true). É muito importante verificar a chave de erro, pois ela fornece informações sobre se houve ou não mmm erro. Você também pode verificar o código do cabeçalho.

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

Cuenta

Obtener cuenta
GET https://urlkai.com/api/account

Para obtener información sobre la cuenta, puede enviar una solicitud a este punto de conexión y devolverá datos sobre la cuenta.

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/account',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/account"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "datos": {
        "id": 1,
        "correo electrónico": " [correo electrónico protegido] ",
        "nombre de usuario": "usuario de muestra",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expira": "2022-11-15 15:00:00",
        "registrado": "2020-11-10 18:01:43"
    }
} 
Actualizar cuenta
PUT https://urlkai.com/api/account/update

Para actualizar la información de la cuenta, puede enviar una solicitud a este punto de conexión y se actualizarán los datos de la cuenta.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "correo electrónico": " [correo electrónico protegido] ",
    "password": "newpassword"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PONER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "correo electrónico": " [correo electrónico protegido] ",
	    "password": "newpassword"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'PUT',
    'url': 'https://urlkai.com/api/account/update',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "correo electrónico": " [correo electrónico protegido] ",
    "password": "newpassword"
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/account/update"
carga útil = {
    "correo electrónico": " [correo electrónico protegido] ",
    "password": "newpassword"
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "correo electrónico": " [correo electrónico protegido] ",
    "password": "newpassword"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "La cuenta se ha actualizado correctamente".
} 

Campanhas

Campañas de listas
GET https://urlkai.com/api/campaigns?limit=2&page=1

Para obtener sus campañas a través de la API, puede utilizar este punto de conexión. También puede filtrar datos (consulte la tabla para obtener más información).

Parâmetro Descrição
límite (Opcional) Resultado de datos por página
página (Opcional) Solicitud de página actual
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": "0",
    "datos": {
        "resultado": 2,
        "por página": 2,
        "currentpage": 1,
        "página siguiente": 1,
        "maxpage": 1,
        "Campañas": [
            {
                "id": 1,
                "name": "Campaña de muestra",
                "público": falso,
                "rotador": falso,
                "lista": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Campaña de Facebook",
                "público": cierto,
                "rotador": "https:\/\/domain.com\/r\/prueba",
                "lista": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Crie uma campanha
POST https://urlkai.com/api/campaign/add

Se puede agregar una campaña mediante este punto de conexión.

Parâmetro Descrição
nombre (Opcional) Nombre de la campaña
trago (Opcional) rotadora
público (Opcional) Acceso
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nueva Campaña",
    "slug": "nueva-campaña",
    "público": verdadero
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PUBLICAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Nueva Campaña",
	    "slug": "nueva-campaña",
	    "público": verdadero
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "name": "Nueva Campaña",
    "slug": "nueva-campaña",
    "público": verdadero
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/campaign/add"
carga útil = {
    "name": "Nueva Campaña",
    "slug": "nueva-campaña",
    "público": verdadero
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "name": "Nueva Campaña",
    "slug": "nueva-campaña",
    "público": verdadero
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "id": 3,
    "domain": "Nueva Campaña",
    "público": cierto,
    "rotator": "https:\/\/domain.com\/r\/nueva-campaña",
    "lista": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Se puede asignar un enlace corto a una campaña utilizando este punto final. El punto de conexión requiere el ID de campaña y el ID de enlace corto.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PUBLICAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'POST',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "Enlace añadido con éxito a la campaña."
} 
Atualizar campanha
PUT https://urlkai.com/api/campaign/:id/update

Para actualizar una campaña, debe enviar datos válidos en JSON a través de una solicitud PUT. Los datos deben enviarse como el cuerpo sin procesar de su solicitud como se muestra a continuación. En el ejemplo siguiente se muestran todos los parámetros que puede enviar, pero no es necesario que los envíe todos (consulte la tabla para obtener más información).

Parâmetro Descrição
nombre (obligatorio) Nombre de la campaña
trago (Opcional) rotadora
público (Opcional) Acceso
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Campaña de Twitter",
    "slug": "campaña-de-twitter",
    "público": verdadero
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PONER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Campaña de Twitter",
	    "slug": "campaña-de-twitter",
	    "público": verdadero
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'PUT',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "name": "Campaña de Twitter",
    "slug": "campaña-de-twitter",
    "público": verdadero
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/campaign/:id/update"
carga útil = {
    "name": "Campaña de Twitter",
    "slug": "campaña-de-twitter",
    "público": verdadero
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "name": "Campaña de Twitter",
    "slug": "campaña-de-twitter",
    "público": verdadero
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "id": 3,
    "domain": "Campaña de Twitter",
    "público": cierto,
    "rotador": "https:\/\/domain.com\/r\/campaña-de-twitter",
    "lista": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Eliminar campaña
DELETE https://urlkai.com/api/campaign/:id/delete

Para eliminar una campaña, debe enviar una solicitud DELETE.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "ELIMINAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'ELIMINAR',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/campaign/:id/delete"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "La campaña se ha eliminado con éxito".
} 

Canais

Canales de lista
GET https://urlkai.com/api/channels?limit=2&page=1

Para obtener sus canales a través de la API, puede usar este punto de conexión. También puede filtrar datos (consulte la tabla para obtener más información).

Parâmetro Descrição
límite (Opcional) Resultado de datos por página
página (Opcional) Solicitud de página actual
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/channels?limit=2&page=1"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": "0",
    "datos": {
        "resultado": 2,
        "por página": 2,
        "currentpage": 1,
        "página siguiente": 1,
        "maxpage": 1,
        "canales": [
            {
                "id": 1,
                "name": "Canal 1",
                "description": "Descripción del canal 1",
                "color": "#000000",
                "Estrellado": Verdadero
            },
            {
                "id": 2,
                "name": "Canal 2",
                "description": "Descripción del canal 2",
                "color": "#FF0000",
                "Estrellado": falso
            }
        ]
    }
} 
Enumerar elementos de canal
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Para obtener elementos en un canal seleccionado a través de la API, puede usar este punto de conexión. También puede filtrar datos (consulte la tabla para obtener más información).

Parâmetro Descrição
límite (Opcional) Resultado de datos por página
página (Opcional) Solicitud de página actual
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": "0",
    "datos": {
        "resultado": 2,
        "por página": 2,
        "currentpage": 1,
        "página siguiente": 1,
        "maxpage": 1,
        "artículos": [
            {
                "type": "enlaces",
                "id": 1,
                "title": "Mi enlace de muestra",
                "vista previa": "https:\/\/google.com",
                "enlace": "https:\/\/urlkai.com\/google",
                "fecha": "2022-05-12"
            },
            {
                "tipo": "biografía",
                "id": 1,
                "title": "Mi biografía de muestra",
                "vista previa": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "fecha": "2022-06-01"
            }
        ]
    }
} 
Canal Criar mmm
POST https://urlkai.com/api/channel/add

Se puede agregar un canal mediante este punto de conexión.

Parâmetro Descrição
nombre (obligatorio) Nombre del canal
descripción (Opcional) Descripción del canal
Color (Opcional) Color del distintivo del canal (HEX)
estrellado (Opcional) Estrella el canal o no (verdadero o falso)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nuevo canal",
    "description": "mi nuevo canal",
    "color": "#000000",
    "Estrellado": Verdadero
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PUBLICAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Nuevo canal",
	    "description": "mi nuevo canal",
	    "color": "#000000",
	    "Estrellado": Verdadero
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "name": "Nuevo canal",
    "description": "mi nuevo canal",
    "color": "#000000",
    "Estrellado": Verdadero
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/channel/add"
carga útil = {
    "name": "Nuevo canal",
    "description": "mi nuevo canal",
    "color": "#000000",
    "Estrellado": Verdadero
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "name": "Nuevo canal",
    "description": "mi nuevo canal",
    "color": "#000000",
    "Estrellado": Verdadero
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "id": 3,
    "name": "Nuevo canal",
    "description": "mi nuevo canal",
    "color": "#000000",
    "Estrellado": Verdadero
} 
Asignar un elemento a un canal
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Un artículo se puede asignar a cualquier canal enviando una solicitud con el ID del canal, el tipo de elemento (enlaces, biografía o qr) y el ID del artículo.

Parâmetro Descrição
:channelid (obligatorio) ID de canal
:tipo (obligatorio) enlaces o biografía o QR
:itemid (obligatorio) ID del artículo
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PUBLICAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'POST',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "Artículo agregado con éxito al canal."
} 
Canal Atualizar
PUT https://urlkai.com/api/channel/:id/update

Para actualizar un canal, debe enviar datos válidos en JSON a través de una solicitud PUT. Los datos deben enviarse como el cuerpo sin procesar de su solicitud como se muestra a continuación. En el ejemplo siguiente se muestran todos los parámetros que puede enviar, pero no es necesario que los envíe todos (consulte la tabla para obtener más información).

Parâmetro Descrição
nombre (Opcional) Nombre del canal
descripción (Opcional) Descripción del canal
Color (Opcional) Color del distintivo del canal (HEX)
estrellado (Opcional) Estrella el canal o no (verdadero o falso)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nombre": "Acme Corp",
    "description": "canal de artículos para Acme Corp",
    "color": "#FFFFFF",
    "Estrellado": falso
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PONER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "nombre": "Acme Corp",
	    "description": "canal de artículos para Acme Corp",
	    "color": "#FFFFFF",
	    "Estrellado": falso
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'PUT',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "nombre": "Acme Corp",
    "description": "canal de artículos para Acme Corp",
    "color": "#FFFFFF",
    "Estrellado": falso
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/channel/:id/update"
carga útil = {
    "nombre": "Acme Corp",
    "description": "canal de artículos para Acme Corp",
    "color": "#FFFFFF",
    "Estrellado": falso
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "nombre": "Acme Corp",
    "description": "canal de artículos para Acme Corp",
    "color": "#FFFFFF",
    "Estrellado": falso
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "El canal se ha actualizado correctamente".
} 
Eliminar canal
DELETE https://urlkai.com/api/channel/:id/delete

Para eliminar un canal, debe enviar una solicitud DELETE. Todos los artículos también se desasignarán.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "ELIMINAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'ELIMINAR',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/channel/:id/delete"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "El canal se ha eliminado correctamente".
} 

Códigos QR

Lista de códigos QR
GET https://urlkai.com/api/qr?limit=2&page=1

Para obtener sus códigos QR a través de la API, puede utilizar este punto final. También puede filtrar datos (consulte la tabla para obtener más información).

Parâmetro Descrição
límite (Opcional) Resultado de datos por página
página (Opcional) Solicitud de página actual
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/qr?limit=2&page=1"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": "0",
    "datos": {
        "resultado": 2,
        "por página": 2,
        "currentpage": 1,
        "página siguiente": 1,
        "maxpage": 1,
        "QRS": [
            {
                "id": 2,
                "enlace": "https:\/\/urlkai.com\/qr\/a2d5e",
                "escaneos": 0,
                "name": "Google",
                "fecha": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "enlace": "https:\/\/urlkai.com\/qr\/b9edfe",
                "escaneos": 5,
                "name": "Google Canadá",
                "fecha": "2020-11-10 18:00:25"
            }
        ]
    }
} 
Obtén un solo código QR
GET https://urlkai.com/api/qr/:id

Para obtener detalles de un solo código QR a través de la API, puede utilizar este punto de conexión.

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/qr/:id',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/qr/:id"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "detalles": {
        "id": 1,
        "enlace": "https:\/\/urlkai.com\/qr\/b9edfe",
        "escaneos": 5,
        "name": "Google Canadá",
        "fecha": "2020-11-10 18:00:25"
    },
    "datos": {
        "clics": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Desconocido": "1"
        },
        "topReferrers": {
            "Directo, correo electrónico y otros": "1"
        },
        "topBrowsers": {
            "Cromo": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "Twitter": 0,
            "Instagram": 0
        }
    }
} 
Crear un código QR
POST https://urlkai.com/api/qr/add

Para crear un código QR, debe enviar un dato válido en JSON a través de una solicitud POST. Los datos deben enviarse como el cuerpo sin procesar de su solicitud como se muestra a continuación. En el ejemplo siguiente se muestran todos los parámetros que puede enviar, pero no es necesario que los envíe todos (consulte la tabla para obtener más información).

Parâmetro Descrição
tipo Texto (obligatorio) | vCard | Enlace | Correo electrónico | Teléfono | SMS | Wifi
datos (obligatorio) Datos a incrustar dentro del código QR. Los datos pueden ser de cadena o de matriz, según el tipo
fondo (Opcional) Color RGB, por ejemplo, rgb (255,255,255)
primer plano (Opcional) Color RGB, por ejemplo, rgb (0,0,0)
logotipo (Opcional) Ruta al logotipo, ya sea png o jpg
nombre (Opcional) Nombre del código QR
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "enlace",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API de código QR"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PUBLICAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "enlace",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "foreground": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "API de código QR"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'POST',
    'url': 'https://urlkai.com/api/qr/add',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "type": "enlace",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API de código QR"
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/qr/add"
carga útil = {
    "type": "enlace",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "API de código QR"
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "type": "enlace",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API de código QR"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "id": 3,
    "enlace": "https:\/\/urlkai.com\/qr\/a58f79"
} 
Actualizar código QR
PUT https://urlkai.com/api/qr/:id/update

Para actualizar un código QR, debe enviar un dato válido en JSON a través de una solicitud PUT. Los datos deben enviarse como el cuerpo sin procesar de su solicitud como se muestra a continuación. En el ejemplo siguiente se muestran todos los parámetros que puede enviar, pero no es necesario que los envíe todos (consulte la tabla para obtener más información).

Parâmetro Descrição
datos (obligatorio) Datos a incrustar dentro del código QR. Los datos pueden ser de cadena o de matriz, según el tipo
fondo (Opcional) Color RGB, por ejemplo, rgb (255,255,255)
primer plano (Opcional) Color RGB, por ejemplo, rgb (0,0,0)
logotipo (Opcional) Ruta al logotipo, ya sea png o jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "enlace",
    "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, matriz(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PONER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "enlace",
	    "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);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'PUT',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "type": "enlace",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/qr/:id/update"
carga útil = {
    "type": "enlace",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "type": "enlace",
    "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");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "QR se ha actualizado con éxito".
} 
Eliminar un código QR
DELETE https://urlkai.com/api/qr/:id/delete

Para eliminar un código QR, debe enviar una solicitud de eliminación.

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "ELIMINAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'ELIMINAR',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/qr/:id/delete"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "El código QR se ha eliminado correctamente".
} 

Domínios de marca

Lista de dominios de marca
GET https://urlkai.com/api/domains?limit=2&page=1

Para obtener sus dominios de marca a través de la API, puede utilizar este punto de conexión. También puede filtrar datos (consulte la tabla para obtener más información).

Parâmetro Descrição
límite (Opcional) Resultado de datos por página
página (Opcional) Solicitud de página actual
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/domains?limit=2&page=1"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": "0",
    "datos": {
        "resultado": 2,
        "por página": 2,
        "currentpage": 1,
        "página siguiente": 1,
        "maxpage": 1,
        "dominios": [
            {
                "id": 1,
                "dominio": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "dominio": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
Crear un dominio de marca
POST https://urlkai.com/api/domain/add

Se puede agregar un dominio mediante este punto de conexión. Por favor, asegúrese de que el dominio esté correctamente apuntado a nuestro servidor.

Parâmetro Descrição
dominio (obligatorio) Dominio de marca, incluyendo http o https
raíz, redireccionamiento (Opcional) Redireccionamiento de root cuando alguien visita tu dominio
redirección404 (Opcional) Redireccionamiento 404 personalizado
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dominio": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PUBLICAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "dominio": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'POST',
    'url': 'https://urlkai.com/api/domain/add',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "dominio": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/domain/add"
carga útil = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "dominio": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "id": 1
} 
Atualizar domínio
PUT https://urlkai.com/api/domain/:id/update

Para actualizar un dominio de marca, debe enviar un dato válido en JSON a través de una solicitud PUT. Los datos deben enviarse como el cuerpo sin procesar de su solicitud como se muestra a continuación. En el ejemplo siguiente se muestran todos los parámetros que puede enviar, pero no es necesario que los envíe todos (consulte la tabla para obtener más información).

Parâmetro Descrição
raíz, redireccionamiento (Opcional) Redireccionamiento de root cuando alguien visita tu dominio
redirección404 (Opcional) Redireccionamiento 404 personalizado
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PONER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'PUT',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/domain/:id/update"
carga útil = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "El dominio se ha actualizado correctamente".
} 
Eliminar dominio
DELETE https://urlkai.com/api/domain/:id/delete

Para eliminar un dominio, debe enviar una solicitud DELETE.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "ELIMINAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'ELIMINAR',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/domain/:id/delete"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "El dominio se ha eliminado con éxito".
} 

Enlaces


Píxeis

Píxeles de lista
GET https://urlkai.com/api/pixels?limit=2&page=1

Para obtener los códigos de píxeles a través de la API, puede utilizar este punto de conexión. También puede filtrar datos (consulte la tabla para obtener más información).

Parâmetro Descrição
límite (Opcional) Resultado de datos por página
página (Opcional) Solicitud de página actual
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/pixels?limit=2&page=1"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": "0",
    "datos": {
        "resultado": 2,
        "por página": 2,
        "currentpage": 1,
        "página siguiente": 1,
        "maxpage": 1,
        "píxeles": [
            {
                "id": 1,
                "tipo": "gtmpixel",
                "name": "GTM Pixel",
                "etiqueta": "GA-123456789",
                "fecha": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "tipo": "twitterpixel",
                "name": "Píxel de Twitter",
                "tag": "1234567",
                "fecha": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Crear un píxel
POST https://urlkai.com/api/pixel/add

Se puede crear un píxel con este punto de conexión. Debe enviar el tipo de píxel y la etiqueta.

Parâmetro Descrição
tipo (obligatorio) gtmpixel | Gapixel | FBPIXEL | Píxel de Adwords| Píxel de LinkedIn | TwitterPixel | AdrollPixel | quorapixel | Pinterest | Bing | Snapchat | Reddit | TikTok
nombre (obligatorio) Nombre personalizado para tu píxel
día (obligatorio) La etiqueta para el píxel
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tipo": "gtmpixel",
    "name": "Mi GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PUBLICAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "tipo": "gtmpixel",
	    "name": "Mi GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'POST',
    'url': 'https://urlkai.com/api/pixel/add',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "tipo": "gtmpixel",
    "name": "Mi GTM",
    "tag": "GTM-ABCDE"
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/pixel/add"
carga útil = {
    "tipo": "gtmpixel",
    "name": "Mi GTM",
    "tag": "GTM-ABCDE"
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "tipo": "gtmpixel",
    "name": "Mi GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "id": 1
} 
Atualizar pixel
PUT https://urlkai.com/api/pixel/:id/update

Para actualizar un píxel, debe enviar datos válidos en JSON a través de una solicitud PUT. Los datos deben enviarse como el cuerpo sin procesar de su solicitud como se muestra a continuación. En el ejemplo siguiente se muestran todos los parámetros que puede enviar, pero no es necesario que los envíe todos (consulte la tabla para obtener más información).

Parâmetro Descrição
nombre (Opcional) Nombre personalizado para tu píxel
día (obligatorio) La etiqueta para el píxel
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Mi GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "PONER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Mi GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'PUT',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    cuerpo: JSON.stringify({
    "name": "Mi GTM",
    "tag": "GTM-ABCDE"
}),
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/pixel/:id/update"
carga útil = {
    "name": "Mi GTM",
    "tag": "GTM-ABCDE"
}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var contenido = new StringContent("{
    "name": "Mi GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "Pixel se ha actualizado correctamente".
} 
Eliminar píxel
DELETE https://urlkai.com/api/pixel/:id/delete

Para eliminar un píxel, debe enviar una solicitud DELETE.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "ELIMINAR",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'ELIMINAR',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/pixel/:id/delete"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": 0,
    "message": "El píxel se ha eliminado correctamente".
} 

Sobreposições de CTA

Lista de superposiciones de CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

Para obtener superposiciones de CTA a través de la API, puede usar este punto de conexión. También puede filtrar datos (consulte la tabla para obtener más información).

Parâmetro Descrição
límite (Opcional) Resultado de datos por página
página (Opcional) Solicitud de página actual
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/overlay?limit=2&page=1"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": "0",
    "datos": {
        "resultado": 2,
        "por página": 2,
        "currentpage": 1,
        "página siguiente": 1,
        "maxpage": 1,
        "CTA": [
            {
                "id": 1,
                "type": "mensaje",
                "name": "Producto 1 Promo",
                "fecha": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "contacto",
                "name": "Página de contacto",
                "fecha": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Splash personalizado

Lista de salpicaduras personalizadas
GET https://urlkai.com/api/splash?limit=2&page=1

Para obtener páginas de presentación personalizadas a través de la API, puede usar este punto de conexión. También puede filtrar datos (consulte la tabla para obtener más información).

Parâmetro Descrição
límite (Opcional) Resultado de datos por página
página (Opcional) Solicitud de página actual
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Autorización: Portador YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriz(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => verdadero,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => verdadero,
    CURLOPT_CUSTOMREQUEST => "OBTENER",
    CURLOPT_HTTPHEADER => [
        "Autorización: Portador YOURAPIKEY",
        "Tipo de contenido: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
eco $response; 
var solicitud = require('solicitud');
opciones var = {
    'método': 'GET',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'encabezados': {
        «Autorización»: «Portador YOURAPIKEY»,
        'Content-Type': 'application/json'
    },
    
};
request(opciones, función (error, respuesta) {
    if (error) lanza un nuevo Error(error);
    console.log(respuesta.cuerpo);
}); 
Solicitudes de importación
url = "https://urlkai.com/api/splash?limit=2&page=1"
carga útil = {}
encabezados = {
    «Autorización»: «Portador YOURAPIKEY»,
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(respuesta.texto) 
var cliente = nuevo HttpClient();
var solicitud = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
pedir. Headers.Add("Autorización", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
pedir. Contenido = contenido;
var respuesta = esperar cliente. SendAsync(solicitud);
respuesta. EnsureSuccessStatusCode();
Console.WriteLine(await response. Content.ReadAsStringAsync()); 
Resposta do servidor
{
    "error": "0",
    "datos": {
        "resultado": 2,
        "por página": 2,
        "currentpage": 1,
        "página siguiente": 1,
        "maxpage": 1,
        "salpicadura": [
            {
                "id": 1,
                "name": "Producto 1 Promo",
                "fecha": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Producto 2 Promo",
                "fecha": "2020-11-10 18:10:00"
            }
        ]
    }
}