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.

Štartér

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. Upozorňujeme, že cena sa môže meniť v závislosti od predplateného plánu.

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

Zoznam prekrytí CTA

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

Ak chcete získať prekrytia cta prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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"
            }
        ]
    }
}

Zoznam súborov

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

Získajte všetky svoje súbory. Môžete tiež vyhľadávať podľa názvu.

Parameter Beskrivelse
meno (voliteľné) Vyhľadanie súboru podľa názvu
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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\/oSvRG",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/HvjYd",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/dVKka",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

Nahratie súboru

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

Nahrajte súbor odoslaním binárnych údajov ako tela príspevku. Musíte odoslať názov súboru vrátane prípony namiesto :filename v adrese URL (napr. brandkit.zip). Možnosti môžete nastaviť odoslaním nasledujúcich parametrov.

Parameter Beskrivelse
meno (voliteľné) Názov súboru
zvyk (voliteľné) Vlastný alias namiesto náhodného aliasu.
doména (voliteľné) Vlastná doména
heslo (voliteľné) Ochrana heslom
uplynutie (voliteľné) Uplynutie platnosti príkladu stiahnutia 2021-09-28
maxdownloads (voliteľné) Maximálny počet stiahnutí
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\/WvDrO"
}

Zoznam kampaní

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

Ak chcete získať kampane prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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

STĹP https://urlkai.com/api/campaign/add

Kampaň je možné pridať pomocou tohto koncového bodu.

Parameter Beskrivelse
meno (voliteľné) Názov kampane
slimák (voliteľné) Rotátorový slimák
verejnosť (voliteľné) Prístup
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"
}
STĹP https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Pomocou tohto koncového bodu je možné ku kampani priradiť krátky odkaz. Koncový bod vyžaduje identifikátor kampane a identifikátor krátkeho prepojenia.

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

DAŤ https://urlkai.com/api/campaign/:id/update

Ak chcete aktualizovať kampaň, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky PUT. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
meno (povinné) Názov kampane
slimák (voliteľné) Rotátorový slimák
verejnosť (voliteľné) Prístup
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"
}

Odstrániť kampaň

ODSTRÁNIŤ https://urlkai.com/api/campaign/:id/delete

Ak chcete kampaň odstrániť, musíte odoslať žiadosť 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."
}

Zoznam kanálov

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

Ak chcete získať svoje kanály prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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
            }
        ]
    }
}

Zoznam položiek kanála

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

Ak chcete získať položky vo vybraných kanáloch prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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

STĹP https://urlkai.com/api/channel/add

Kanál je možné pridať pomocou tohto koncového bodu.

Parameter Beskrivelse
meno (povinné) Názov kanála
popis (voliteľné) Popis kanála
farba (voliteľné) Farba odznaku kanála (HEX)
Hral (voliteľné) Kanál označte hviezdičkou alebo nie (pravda alebo nepravda)
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
}

Priradenie položky ku kanálu

STĹP https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Položku je možné priradiť k ľubovoľnému kanálu odoslaním požiadavky s ID kanála, typom položky (odkazy, bio alebo qr) a ID položky.

Parameter Beskrivelse
:identifikátor kanála (povinné) Identifikácia kanála
:typ (povinné) odkazy alebo životopis alebo QR
:itemid (povinné) ID položky
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

DAŤ https://urlkai.com/api/channel/:id/update

Ak chcete aktualizovať kanál, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky PUT. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
meno (voliteľné) Názov kanála
popis (voliteľné) Popis kanála
farba (voliteľné) Farba odznaku kanála (HEX)
Hral (voliteľné) Kanál označte hviezdičkou alebo nie (pravda alebo nepravda)
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."
}

Odstrániť kanál

ODSTRÁNIŤ https://urlkai.com/api/channel/:id/delete

Ak chcete kanál odstrániť, musíte odoslať žiadosť o odstránenie. Všetky položky budú tiež nepriradené.

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

Zoznam značkových domén

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

Ak chcete získať svoje značkové domény prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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"
            }
        ]
    }
}

Vytvorenie značkovej domény

STĹP https://urlkai.com/api/domain/add

Pomocou tohto koncového bodu je možné pridať doménu. Uistite sa, že doména je správne nasmerovaná na náš server.

Parameter Beskrivelse
doména (povinné) Značková doména vrátane http alebo https
Redirectroot (voliteľné) Koreňové presmerovanie, keď niekto navštívi vašu doménu
presmerovanie404 (voliteľné) Vlastné presmerovanie 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

DAŤ https://urlkai.com/api/domain/:id/update

Ak chcete aktualizovať značkovú doménu, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky PUT. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
Redirectroot (voliteľné) Koreňové presmerovanie, keď niekto navštívi vašu doménu
presmerovanie404 (voliteľné) Vlastné presmerovanie 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."
}

Odstrániť doménu

ODSTRÁNIŤ https://urlkai.com/api/domain/:id/delete

Ak chcete doménu odstrániť, musíte odoslať žiadosť 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

Zoznam QR kódov

DOSTAŤ 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).

Parameter Beskrivelse
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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

DOSTAŤ 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

STĹP https://urlkai.com/api/qr/add

Ak chcete vytvoriť QR kód, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky POST. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
typ (povinné) text | vcard | odkaz | e-mailom | telefón | SMS | Wi-Fi
údaje (povinné) Údaje, ktoré sa majú vložiť do QR kódu. Údaje môžu byť reťazec alebo pole v závislosti od typu
pozadie (voliteľné) Farba RGB, napr. rgb(255,255,255)
popredie (voliteľné) Farba RGB, napr. rgb(0,0,0)
logo (voliteľné) Cesta k logu buď png alebo jpg
meno (voliteľné) Názov QR kódu
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"
}

Aktualizácia QR kódu

DAŤ 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).

Parameter Beskrivelse
údaje (povinné) Údaje, ktoré sa majú vložiť do QR kódu. Údaje môžu byť reťazec alebo pole v závislosti od typu
pozadie (voliteľné) Farba RGB, napr. rgb(255,255,255)
popredie (voliteľné) Farba RGB, napr. rgb(0,0,0)
logo (voliteľné) Cesta k logu buď png alebo 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

ODSTRÁNIŤ 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

DOSTAŤ 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

DAŤ 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

Zoznam vlastných Splash

DOSTAŤ 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).

Parameter Beskrivelse
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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"
            }
        ]
    }
}

Zoznam pixelov

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

Ak chcete získať kódy pixelov prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
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"
            }
        ]
    }
}

Vytvorenie pixelu

STĹP https://urlkai.com/api/pixel/add

Pomocou tohto koncového bodu je možné vytvoriť pixel. Musíte odoslať typ pixelu a značku.

Parameter Beskrivelse
typ (povinné) gtmpixel | Gapixel | fbpixel | AdWordsPixel | LinkedInInpixel | Twitterpixel | AdrollPixel | Quorapixel | Pinterest | Bing | Snapchat | Reddit | TikTok
meno (povinné) Vlastný názov pixelu
štítok (povinné) Značka pre 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

DAŤ https://urlkai.com/api/pixel/:id/update

Ak chcete aktualizovať pixel, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky PUT. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parameter Beskrivelse
meno (voliteľné) Vlastný názov pixelu
štítok (povinné) Značka pre 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."
}

Odstrániť Pixel

ODSTRÁNIŤ https://urlkai.com/api/pixel/:id/delete

Ak chcete pixel odstrániť, musíte odoslať žiadosť o odstránenie.

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