Developers

API-referanse para utviklere

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.

Arranque

En API-nøkkel kreves for at forespørsler skal behandles av systemet. Når en bruker registrerer seg, genereres det automatisk en API-nøkkel for denne brukeren. API-nøkkelen må sendes med hver forespørsel (se fullstendig eksempel nedenfor). Hvis API-nøkkelen ikke sendes eller er utløpt, vil det oppstå en feil. Sørg for å holde API-nøkkelen hemmelig for å forhindre misbruk.

Godkjenning

For å autentisere med API-systemet, må du sende API-nøkkelen din som et autorisasjonstoken med hver forespørsel. Du kan se eksempelkoden nedenfor.

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \ 

Satsgrense

API-en vår har en hastighetsbegrenser for å beskytte mot økning i forespørsler for å maksimere stabiliteten. Satsbegrenseren vår er for øyeblikket begrenset til 30 forespørsler per 1 minutt. Por favor, note que a tarifa pode mudar de acordo com o plano subscrito.

Flere overskrifter vil bli sendt ved siden av svaret, og disse kan undersøkes for å finne ulike opplysninger om forespørselen.

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

Responshåndtering

Alle API-svar returneres som standard i JSON-format. For å konvertere dette til brukbare data, må den aktuelle funksjonen brukes i henhold til språket. I PHP kan funksjonen json_decode() brukes til å konvertere dataene til enten et objekt (standard) eller en matrise (sett den andre parameteren til true). Det er veldig viktig å sjekke feilnøkkelen, da den gir informasjon om det var en feil eller ikke. Du kan også sjekke overskriftskoden.

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

CTA-overlegg

Listar sobreposições de CTA

OBTER https://urlkai.com/api/overlay?limit=2&page=1

Para obter sobreposições de cta por meio da API, você pode usar esse ponto de extremidade. Você também pode filtrar dados (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "message",
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "contact",
                "name": "Contact Page",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

Ficheiros

Ficheiros de Lista

OBTER https://urlkai.com/api/files?limit=2&page=1

Recupera todos os teus ficheiros. Também pode pesquisar por nome.

Parâmetro Beskrivelse
Designação (opcional) Procure um ficheiro por nome
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/LWahm",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/pDTbl",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/ZzFZX",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

Carregar um ficheiro

PUBLICAR https://urlkai.com/api/files/upload/:filename?name=My+File

Carrega um ficheiro enviando os dados binários como o corpo da publicação. Tens de enviar o nome do ficheiro incluindo a extensão em vez de :filename na URL (por exemplo, brandkit.zip). Pode definir opções enviando os seguintes parâmetros.

Parâmetro Beskrivelse
Designação (opcional) Nome do ficheiro
Personalizado (facultativo) Alias personalizado em vez de alias aleatório.
domínio (facultativo) Domínio Personalizado
palavra-passe (facultativo) Proteção por palavra-passe
expiração (opcional) Validade do exemplo de download 2021-09-28
maxdownloads (opcional) Número máximo de downloads
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"'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/DnYRp"
}

Kampanjer

Listar Campanhas

OBTER https://urlkai.com/api/campaigns?limit=2&page=1

Para obter suas campanhas por meio da API, você pode usar esse ponto de extremidade. Você também pode filtrar dados (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "campaigns": [
            {
                "id": 1,
                "name": "Sample Campaign",
                "public": false,
                "rotator": false,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook Campaign",
                "public": true,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
}

Opprett en kampanje

PUBLICAR https://urlkai.com/api/campaign/add

Uma campanha pode ser adicionada usando este ponto de extremidade.

Parâmetro Beskrivelse
Designação (facultativo) Nome da campanha
lesma (facultativo) Lesma Rotadora
público (facultativo) Acesso
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "id": 3,
    "domain": "New Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}
PUBLICAR https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Um link curto pode ser atribuído a uma campanha usando esse ponto de extremidade. O endpoint requer o ID da campanha e o ID do link curto.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Link successfully added to the campaign."
}

Oppdater kampanje

COLOCAR https://urlkai.com/api/campaign/:id/update

Para atualizar uma campanha, você precisa enviar dados válidos em JSON por meio de uma solicitação PUT. Os dados devem ser enviados como o corpo bruto do seu pedido, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
Designação (obrigatório) Nome da campanha
lesma (facultativo) Lesma Rotadora
público (facultativo) Acesso
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "id": 3,
    "domain": "Twitter Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
}

Excluir campanha

SUPRIMIR https://urlkai.com/api/campaign/:id/delete

Para excluir uma campanha, você precisa enviar uma solicitação DELETE.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Campaign has been deleted successfully."
}

Listar canais

OBTER https://urlkai.com/api/channels?limit=2&page=1

Para obter seus canais por meio da API, você pode usar esse ponto de extremidade. Você também pode filtrar dados (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "channels": [
            {
                "id": 1,
                "name": "Channel 1",
                "description": "Description of channel 1",
                "color": "#000000",
                "starred": true
            },
            {
                "id": 2,
                "name": "Channel 2",
                "description": "Description of channel 2",
                "color": "#FF0000",
                "starred": false
            }
        ]
    }
}

Listar itens do canal

OBTER https://urlkai.com/api/channel/:id?limit=1&page=1

Para obter itens em um canal selecionado por meio da API, você pode usar esse ponto de extremidade. Você também pode filtrar dados (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "items": [
            {
                "type": "links",
                "id": 1,
                "title": "My Sample Link",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "date": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "My Sample Bio",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "date": "2022-06-01"
            }
        ]
    }
}

Opprett en kanal

PUBLICAR https://urlkai.com/api/channel/add

Um canal pode ser adicionado usando este ponto de extremidade.

Parâmetro Beskrivelse
Designação (obrigatório) Nome do canal
Descrição (facultativo) Descrição do canal
Cor (facultativo) Cor do selo do canal (HEX)
estrelado (facultativo) Marcar ou não o canal (verdadeiro ou falso)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "id": 3,
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}

Atribuir um item a um canal

PUBLICAR https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Um item pode ser atribuído a qualquer canal enviando uma solicitação com o ID do canal, tipo de item (links, bio ou qr) e ID do item.

Parâmetro Beskrivelse
:canalid (obrigatório) ID do canal
:tipo (obrigatório) links ou bio ou qr
:itemid (obrigatório) Item ID
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Item successfully added to the channel."
}

Oppdater kanalen

COLOCAR https://urlkai.com/api/channel/:id/update

Para atualizar um canal, você precisa enviar dados válidos em JSON por meio de uma solicitação PUT. Os dados devem ser enviados como o corpo bruto do seu pedido, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
Designação (facultativo) Nome do canal
Descrição (facultativo) Descrição do canal
Cor (facultativo) Cor do selo do canal (HEX)
estrelado (facultativo) Marcar ou não o canal (verdadeiro ou falso)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "channel for items for Acme Corp",
    "color": "#FFFFFF",
    "starred": false
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Channel has been updated successfully."
}

Excluir canal

SUPRIMIR https://urlkai.com/api/channel/:id/delete

Para excluir um canal, você precisa enviar uma solicitação DELETE. Todos os itens também não serão atribuídos.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Channel has been deleted successfully."
}

Merkede domener

Listar Domínios de Marca

OBTER https://urlkai.com/api/domains?limit=2&page=1

Para obter seus domínios de marca por meio da API, você pode usar esse ponto de extremidade. Você também pode filtrar dados (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "domains": [
            {
                "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"
            }
        ]
    }
}

Criar um domínio de marca

PUBLICAR https://urlkai.com/api/domain/add

Um domínio pode ser adicionado usando esse ponto de extremidade. Por favor, certifique-se de que o domínio está corretamente apontado para o nosso servidor.

Parâmetro Beskrivelse
domínio (obrigatório) Domínio de marca, incluindo http ou https
raiz de redirecionamento (facultativo) Redirecionamento de raiz quando alguém visita o seu domínio
redirecionamento404 (facultativo) Redirecionamento personalizado 404
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "id": 1
}

Oppdater domene

COLOCAR https://urlkai.com/api/domain/:id/update

Para atualizar um domínio de marca, você precisa enviar dados válidos em JSON por meio de uma solicitação PUT. Os dados devem ser enviados como o corpo bruto do seu pedido, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
raiz de redirecionamento (facultativo) Redirecionamento de raiz quando alguém visita o seu domínio
redirecionamento404 (facultativo) Redirecionamento personalizado 404
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Domain has been updated successfully."
}

Excluir domínio

SUPRIMIR https://urlkai.com/api/domain/:id/delete

Para excluir um domínio, você precisa enviar uma solicitação DELETE.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Domain has been deleted successfully."
}

QR-koder

Listar códigos QR

OBTER https://urlkai.com/api/qr?limit=2&page=1

Para å få QR-kodene dine via API, kan du bruke dette endepunktet. Du kan også filtrere data (se tabell for mer info).

Parâmetro Beskrivelse
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 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"
            }
        ]
    }
}

Få en enkelt QR-kode

OBTER https://urlkai.com/api/qr/:id

For å få detaljer for en enkelt QR-kode via API, kan du bruke dette endepunktet.

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "scans": 5,
        "name": "Google Canada",
        "date": "2020-11-10 18:00:25"
    },
    "data": {
        "clicks": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Unknown": "1"
        },
        "topReferrers": {
            "Direct, email and other": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "instagram": 0
        }
    }
}

Lag en QR-kode

PUBLICAR https://urlkai.com/api/qr/add

Para criar um QR Code, você precisa enviar um dado válido em JSON por meio de uma solicitação POST. Os dados devem ser enviados como o corpo bruto do seu pedido, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
tipo texto (obrigatório) | vcard | ligação | e-mail | telefone | SMS | Wi-Fi
dados (obrigatório) Dados a incorporar dentro do código QR. Os dados podem ser string ou array, dependendo do tipo
Contexto geral (facultativo) Cor RGB, por exemplo, rgb(255,255,255)
primeiro plano (facultativo) Cor RGB, por exemplo, rgb(0,0,0)
Logótipo (facultativo) Caminho para o logotipo png ou jpg
Designação (facultativo) Nome do código QR
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR Code API"
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "id": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
}

Atualizar QR Code

COLOCAR https://urlkai.com/api/qr/:id/update

Para å oppdatere en QR-kode, må du sende en gyldig data i JSON via en PUT-forespørsel. Dataene må sendes som råteksten til forespørselen din som vist nedenfor. Eksemplet nedenfor viser alle parameterne du kan sende, men du er ikke pålagt å sende alle (se tabellen for mer info).

Parâmetro Beskrivelse
dados (obrigatório) Dados a incorporar dentro do código QR. Os dados podem ser string ou array, dependendo do tipo
Contexto geral (facultativo) Cor RGB, por exemplo, rgb(255,255,255)
primeiro plano (facultativo) Cor RGB, por exemplo, rgb(0,0,0)
Logótipo (facultativo) Caminho para o logotipo png ou jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "QR has been updated successfully."
}

Slett en QR-kode

SUPRIMIR https://urlkai.com/api/qr/:id/delete

For å slette en QR-kode må du sende en SLETT-forespørsel.

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "QR Code has been deleted successfully."
}

Regnskap

Få konto

OBTER https://urlkai.com/api/account

For å få informasjon om kontoen kan du sende en forespørsel til dette endepunktet og det vil returnere data på kontoen.

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "data": {
        "id": 1,
        "email": "[email protected]",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expires": "2022-11-15 15:00:00",
        "registered": "2020-11-10 18:01:43"
    }
}

Oppdater konto

COLOCAR https://urlkai.com/api/account/update

For å oppdatere informasjon om kontoen, kan du sende en forespørsel til dette endepunktet, og det vil oppdatere data på kontoen.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "[email protected]",
    "password": "NewPassword1"
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Account has been successfully updated."
}

Tilpasset Salpicos

Listar Splash Personalizado

OBTER https://urlkai.com/api/splash?limit=2&page=1

To get Splash Pages via the API, you can use this endpoint. You can also filter data (See table for more info).

Parâmetro Beskrivelse
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Product 2 Promo",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

Lista de pixels

OBTER https://urlkai.com/api/pixels?limit=2&page=1

Para obter seus códigos de pixels por meio da API, você pode usar esse ponto de extremidade. Você também pode filtrar dados (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
limite (facultativo) Resultado de dados por página
página (facultativo) Pedido de página atual
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 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": "Twitter Pixel",
                "tag": "1234567",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

Criar um pixel

PUBLICAR https://urlkai.com/api/pixel/add

Um pixel pode ser criado usando esse ponto de extremidade. Você precisa enviar o tipo de pixel e a tag.

Parâmetro Beskrivelse
tipo (obrigatório) gtmpixel | Gapixel - Brasil | FBPeril | adwordspixel | linkedinpixel | twitterpixel | Adrollpixel | quorapixel | Pinterest | Bing | Snapchat - Brasil | reddit | TikTok
Designação (obrigatório) Nome personalizado para o pixel
tag (obrigatório) A tag para o pixel
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "id": 1
}

Oppdater Pixel

COLOCAR https://urlkai.com/api/pixel/:id/update

Para atualizar um pixel, você precisa enviar dados válidos em JSON por meio de uma solicitação PUT. Os dados devem ser enviados como o corpo bruto do seu pedido, conforme mostrado abaixo. O exemplo abaixo mostra todos os parâmetros que você pode enviar, mas não é obrigado a enviar todos (Consulte a tabela para obter mais informações).

Parâmetro Beskrivelse
Designação (facultativo) Nome personalizado para o pixel
tag (obrigatório) A tag para o pixel
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Pixel has been updated successfully."
}

Excluir pixel

SUPRIMIR https://urlkai.com/api/pixel/:id/delete

Para excluir um pixel, você precisa enviar uma solicitação DELETE.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Dette skriptet lar deg forkorte alle (eller velg) nettadresser på nettstedet ditt veldig enkelt. Alt du trenger å gjøre er å kopiere og lime inn koden under på slutten av siden din. Du kan tilpasse selgeren når du ønsker å målrette nettadresser i en bestemt velger. Merk at du bare kan kopiere koden under, fordi alt er allerede for deg.

{
    "error": 0,
    "message": "Pixel has been deleted successfully."
}