Developers

API-referanse for 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.

Demaror

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. Vă rugăm să rețineți că tariful se poate modifica în funcție de planul subscris.

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

Listați suprapunerile CTA

OBȚINE https://urlkai.com/api/overlay?limit=2&page=1

Pentru a obține suprapuneri cta prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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"
            }
        ]
    }
}

Fişierele

Fișiere de listă

OBȚINE https://urlkai.com/api/files?limit=2&page=1

Obțineți toate fișierele. De asemenea, puteți căuta după nume.

Parametru Beskrivelse
nume (opțional) Căutarea unui fișier după nume
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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\/GeDVR",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/UXuZI",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/GDuNB",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

Încărcați un fișier

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

Încărcați un fișier trimițând datele binare ca corp al postării. Trebuie să trimiteți numele fișierului, inclusiv extensia, în loc de :filename în url (de exemplu, brandkit.zip). Puteți seta opțiunile trimițând următorii parametri.

Parametru Beskrivelse
nume (opțional) Nume fișier
obicei (opțional) Alias personalizat în loc de alias aleatoriu.
domeniu (opțional) Domeniu personalizat
parolă (opțional) Protecție prin parolă
Expirare (opțional) Expirarea pentru exemplul de descărcare 2021-09-28
descărcări maxime (opțional) Numărul maxim de descărcări
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\/JtXXs"
}

Kampanjer

Listați campaniile

OBȚINE https://urlkai.com/api/campaigns?limit=2&page=1

Pentru a obține campaniile prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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

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

O campanie poate fi adăugată folosind acest punct final.

Parametru Beskrivelse
nume (opțional) Numele campaniei
melc (opțional) Rotator Slug
public (opțional) Acces
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"
}
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Un link scurt poate fi atribuit unei campanii folosind acest punct final. Punctul final necesită ID-ul campaniei și ID-ul linkului scurt.

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

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

Pentru a actualiza o campanie, trebuie să trimiteți date valide în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
nume (obligatoriu) Numele campaniei
melc (opțional) Rotator Slug
public (opțional) Acces
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"
}

Ștergeți campania

ȘTERGE https://urlkai.com/api/campaign/:id/delete

Pentru a șterge o campanie, trebuie să trimiteți o solicitare de ȘTERGERE.

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."
}

Lista canalelor

OBȚINE https://urlkai.com/api/channels?limit=2&page=1

Pentru a obține canalele prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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
            }
        ]
    }
}

Listați elementele canalului

OBȚINE https://urlkai.com/api/channel/:id?limit=1&page=1

Pentru a obține elemente dintr-un anumit canal prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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

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

Un canal poate fi adăugat folosind acest punct final.

Parametru Beskrivelse
nume (obligatoriu) Numele canalului
descriere (opțional) Descrierea canalului
culoare (opțional) Culoarea insignei canalului (HEX)
Jucat (opțional) Marcați canalul cu o stea sau nu (adevărat sau fals)
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
}

Atribuirea unui articol unui canal

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

Un articol poate fi atribuit oricărui canal prin trimiterea unei solicitări cu ID-ul canalului, tipul articolului (link-uri, biografie sau qr) și ID-ul articolului.

Parametru Beskrivelse
:channelid (obligatoriu) ID-ul canalului
:tip (obligatoriu) link-uri sau bio sau qr
:itemid (obligatoriu) ID articol
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

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

Pentru a actualiza un canal, trebuie să trimiteți date valide în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
nume (opțional) Numele canalului
descriere (opțional) Descrierea canalului
culoare (opțional) Culoarea insignei canalului (HEX)
Jucat (opțional) Marcați canalul cu o stea sau nu (adevărat sau fals)
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."
}

Ștergeți canalul

ȘTERGE https://urlkai.com/api/channel/:id/delete

Pentru a șterge un canal, trebuie să trimiți o solicitare de ȘTERGERE. Toate elementele vor fi de asemenea anulate.

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

Listați domeniile de marcă

OBȚINE https://urlkai.com/api/domains?limit=2&page=1

Pentru a obține domeniile de marcă prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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"
            }
        ]
    }
}

Creați un domeniu de marcă

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

Un domeniu poate fi adăugat folosind acest punct final. Vă rugăm să vă asigurați că domeniul este direcționat corect către serverul nostru.

Parametru Beskrivelse
domeniu (obligatoriu) Domeniu de marcă, inclusiv http sau https
redirecționare rădăcină (opțional) Redirecționare root atunci când cineva îți vizitează domeniul
redirecționare404 (opțional) Redirecționare 404 personalizată
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

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

Pentru a actualiza un domeniu de marcă, trebuie să trimiteți date valide în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
redirecționare rădăcină (opțional) Redirecționare root atunci când cineva îți vizitează domeniul
redirecționare404 (opțional) Redirecționare 404 personalizată
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."
}

Ștergeți domeniul

ȘTERGE https://urlkai.com/api/domain/:id/delete

Pentru a șterge un domeniu, trebuie să trimiteți o solicitare de ȘTERGERE.

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

Listați codurile QR

OBȚINE https://urlkai.com/api/qr?limit=2&page=1

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

Parametru Beskrivelse
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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

OBȚINE 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

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

Pentru a crea un cod QR, trebuie să trimiteți date valide în JSON printr-o solicitare POST. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
tip text (obligatoriu) | vcard | legătură | E-mail | telefon | SMS | Wi-Fi
date (obligatoriu) Date care trebuie încorporate în codul QR. Datele pot fi șir sau matrice în funcție de tip
fond (opțional) Culoare RGB, de exemplu rgb (255,255,255)
Prim plan (opțional) Culoare RGB, de exemplu rgb(0,0,0)
siglă (opțional) Calea către logo, fie png, fie jpg
nume (opțional) Numele codului 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"
}

Actualizați codul QR

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

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

Parametru Beskrivelse
date (obligatoriu) Date care trebuie încorporate în codul QR. Datele pot fi șir sau matrice în funcție de tip
fond (opțional) Culoare RGB, de exemplu rgb (255,255,255)
Prim plan (opțional) Culoare RGB, de exemplu rgb(0,0,0)
siglă (opțional) Calea către logo, fie png, fie 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

ȘTERGE 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

OBȚINE 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

PUNE 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 Splash

Listați Splash personalizat

OBȚINE 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).

Parametru Beskrivelse
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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 pixeli

OBȚINE https://urlkai.com/api/pixels?limit=2&page=1

Pentru a obține codurile pixelilor prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
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"
            }
        ]
    }
}

Creați un pixel

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

Un pixel poate fi creat folosind acest punct final. Trebuie să trimiteți tipul de pixel și eticheta.

Parametru Beskrivelse
tip (obligatoriu) gtmpixel | gapixel | fbpixel | adwordspixel | LinkedInPixel | TwitterPixel | AdrollPixel | Quorapixel | Pinterest | Bing | Snapchat | reddit | TikTok
nume (obligatoriu) Nume personalizat pentru pixel
etichetă (obligatoriu) Eticheta pentru 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

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

Pentru a actualiza un pixel, trebuie să trimiteți date valide în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Beskrivelse
nume (opțional) Nume personalizat pentru pixel
etichetă (obligatoriu) Eticheta pentru 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."
}

Ștergeți pixelul

ȘTERGE https://urlkai.com/api/pixel/:id/delete

Pentru a șterge un pixel, trebuie să trimiteți o solicitare de ȘTERGERE.

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."
}