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.

सुरुआतकर्ता

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. कृपया ध्यान दिनुहोस् कि सदस्यता लिएको योजना अनुसार दर परिवर्तन हुन सक्छ।

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

सीटीए ओभरले सूची गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/overlay?limit=2&page=1

एपीआई मार्फत सीटीए ओभरलेहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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"
            }
        ]
    }
}

फाइल

सूची फाइलहरू

गेट गर्नुहोस् https://urlkai.com/api/files?limit=2&page=1

तपाईंको सबै फाइलहरू प्राप्त गर्नुहोस्। तपाईं नाम द्वारा पनि खोजी गर्न सक्नुहुन्छ।

प्यारामिटर Beskrivelse
नाम (वैकल्पिक) नामद्वारा फाइलका लागि खोजी गर्नुहोस्
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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\/zqfRC",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/nQNNe",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/PZQra",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

फाइल अपलोड गर्नुहोस्

पोस्ट https://urlkai.com/api/files/upload/:filename?name=My+File

पोस्ट बडीको रूपमा बाइनरी डेटा पठाएर फाइल अपलोड गर्नुहोस्। तपाईँले यूआरएलमा :फाइलनाम (उदाहरणका लागि brandkit.zip) को सट्टामा एक्सटेन्सन सहित फाइल नाम पठाउनु आवश्यक छ । तपाईँले निम्न परिमितिहरू पठाएर विकल्पहरू सेट गर्न सक्नुहुन्छ ।

प्यारामिटर Beskrivelse
नाम (वैकल्पिक) फाइल नाम
अनुकूल (वैकल्पिक) अनियमित उपनामको सट्टामा अनुकूलन उपनाम ।
डोमेन (वैकल्पिक) अनुकूल डोमेन
पासवर्ड (वैकल्पिक) पासवर्ड सुरक्षा
म्याद समाप्त हुन्छ (वैकल्पिक) डाउनलोड उदाहरणको लागि समाप्ति 2021-09-28
maxdownloads (वैकल्पिक) डाउनलोडको अधिकतम सङ्ख्या
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\/jkqPg"
}

Kampanjer

अभियानहरूको सूची बनाउनुहोस्

गेट गर्नुहोस् https://urlkai.com/api/campaigns?limit=2&page=1

एपीआई मार्फत तपाईंको अभियानहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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

पोस्ट https://urlkai.com/api/campaign/add

यो अन्त्यबिन्दु प्रयोग गरेर अभियान थप्न सकिन्छ ।

प्यारामिटर Beskrivelse
नाम (वैकल्पिक) अभियानको नाम
स्लग (वैकल्पिक) रोटेटर स्लग
सार्वजनिक (वैकल्पिक) पहुँच
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"
}
पोस्ट https://urlkai.com/api/campaign/:campaignid/assign/:linkid

यो अन्त्यबिन्दु प्रयोग गरेर एउटा अभियानमा एउटा छोटो लिङ्क असाइन गर्न सकिन्छ । अन्त्यबिन्दुका लागि अभियान आईडी र छोटो लिङ्क आईडी आवश्यक पर्दछ ।

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

पुट https://urlkai.com/api/campaign/:id/update

अभियान अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
नाम (आवश्यक) अभियानको नाम
स्लग (वैकल्पिक) रोटेटर स्लग
सार्वजनिक (वैकल्पिक) पहुँच
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"
}

अभियान मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/campaign/:id/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."
}

च्यानलहरू सूचीबद्ध गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/channels?limit=2&page=1

एपीआई मार्फत तपाईंको च्यानलहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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
            }
        ]
    }
}

च्यानल वस्तुहरूको सूची बनाउनुहोस्

गेट गर्नुहोस् https://urlkai.com/api/channel/:id?limit=1&page=1

एपीआई मार्फत चयन गरिएका च्यानलहरूमा वस्तुहरू प्राप्त गर्न, तपाईँले यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ । तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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

पोस्ट https://urlkai.com/api/channel/add

यो अन्त्यबिन्दु प्रयोग गरेर एउटा च्यानल थप्न सकिन्छ ।

प्यारामिटर Beskrivelse
नाम (आवश्यक) च्यानल नाम
वर्णन[सम्पादन गर्ने] (वैकल्पिक) च्यानल वर्णन
रङ (वैकल्पिक) च्यानल बिल्ला रङ (एचईएक्स)
तारांकित (वैकल्पिक) च्यानल स्टार गर्नुहोस् वा नगर्नुहोस् (सही वा गलत)
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
}

च्यानलमा एउटा वस्तु निर्दिष्ट गर्नुहोस्

पोस्ट https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

च्यानल आईडी, आइटम प्रकार (लिङ्क, बायो वा क्यूआर) र आइटम आईडीको साथ अनुरोध पठाएर कुनै पनि च्यानलमा वस्तु असाइन गर्न सकिन्छ।

प्यारामिटर Beskrivelse
:channelid (आवश्यक) च्यानल आईडी
: प्रकार (आवश्यक) लिंक वा बायो वा क्यूआर
:itemid (आवश्यक) वस्तु आईडी
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

पुट https://urlkai.com/api/channel/:id/update

च्यानल अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
नाम (वैकल्पिक) च्यानल नाम
वर्णन[सम्पादन गर्ने] (वैकल्पिक) च्यानल वर्णन
रङ (वैकल्पिक) च्यानल बिल्ला रङ (एचईएक्स)
तारांकित (वैकल्पिक) च्यानल स्टार गर्नुहोस् वा नगर्नुहोस् (सही वा गलत)
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."
}

च्यानल मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/channel/:id/delete

एउटा च्यानल मेट्नका लागि, तपाईँले मेट्न अनुरोध पठाउनु पर्दछ । सबै वस्तुहरू पनि असाइन गरिएको हुनेछ।

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

ब्रान्डेड डोमेनहरूको सूची बनाउनुहोस्

गेट गर्नुहोस् https://urlkai.com/api/domains?limit=2&page=1

एपीआई मार्फत तपाईंको ब्रान्डेड डोमेनहरू प्राप्त गर्न, तपाईं यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुनेछ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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"
            }
        ]
    }
}

ब्रान्डेड डोमेन सिर्जना गर्नुहोस्

पोस्ट https://urlkai.com/api/domain/add

यो अन्त्यबिन्दु प्रयोग गरेर डोमेन थप्न सकिन्छ । कृपया निश्चित गर्नुहोस् कि डोमेन हाम्रो सर्भरमा सही तरिकाले इंगित गरिएको छ।

प्यारामिटर Beskrivelse
डोमेन (आवश्यक) एचटीटीपी वा https सहित ब्रान्डेड डोमेन
redirectroot (वैकल्पिक) कसैले तपाईँको डोमेन भ्रमण गर्दा रूट रिडाइरेक्ट गर्नुहोस्
पुनर्निर्देशन404 (वैकल्पिक) अनुकूल 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

पुट https://urlkai.com/api/domain/:id/update

ब्रान्डेड डोमेन अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
redirectroot (वैकल्पिक) कसैले तपाईँको डोमेन भ्रमण गर्दा रूट रिडाइरेक्ट गर्नुहोस्
पुनर्निर्देशन404 (वैकल्पिक) अनुकूल 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."
}

डोमेन मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/domain/:id/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

क्यूआर कोडहरू सूचीबद्ध गर्नुहोस्

गेट गर्नुहोस् 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).

प्यारामिटर Beskrivelse
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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

गेट गर्नुहोस् 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

पोस्ट https://urlkai.com/api/qr/add

क्यूआर कोड सिर्जना गर्न, तपाईले पोस्ट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
प्रकार (आवश्यक) पाठ | भिकार्ड | लिङ्क | इमेल | फोन | एसएमएस | वाईफाई
डेटा (आवश्यक) क्यूआर कोडभित्र डाटा एम्बेडेड गर्नुपर्नेछ । प्रकारमा निर्भर गर्दै डेटा स्ट्रिङ वा एरे हुन सक्छ
पृष्ठभूमि (वैकल्पिक) आरजीबी रङ जस्तै आरजीबी (255,255,255)
अग्रभूमि (वैकल्पिक) आरजीबी रङ उदाहरणका लागि आरजीबी (०,०,०)
logo (वैकल्पिक) लोगोको मार्ग या त पीएनजी वा जेपीजी
नाम (वैकल्पिक) क्यूआर कोड नाम
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"
}

क्यूआर कोड अद्यावधिक गर्नुहोस्

पुट 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).

प्यारामिटर Beskrivelse
डेटा (आवश्यक) क्यूआर कोडभित्र डाटा एम्बेडेड गर्नुपर्नेछ । प्रकारमा निर्भर गर्दै डेटा स्ट्रिङ वा एरे हुन सक्छ
पृष्ठभूमि (वैकल्पिक) आरजीबी रङ जस्तै आरजीबी (255,255,255)
अग्रभूमि (वैकल्पिक) आरजीबी रङ उदाहरणका लागि आरजीबी (०,०,०)
logo (वैकल्पिक) लोगोको मार्ग या त पीएनजी वा जेपीजी
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

मेट्नुहोस् 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

गेट गर्नुहोस् 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

पुट 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

अनुकूल स्प्ल्याश सूची बनाउनुहोस्

गेट गर्नुहोस् 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).

प्यारामिटर Beskrivelse
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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"
            }
        ]
    }
}

पिक्सेल सूची गर्नुहोस्

गेट गर्नुहोस् https://urlkai.com/api/pixels?limit=2&page=1

एपीआई मार्फत तपाईंको पिक्सेल कोडहरू प्राप्त गर्न, तपाईँले यो अन्त्यबिन्दु प्रयोग गर्न सक्नुहुन्छ। तपाईँले डेटा फिल्टर गर्न सक्नुहुन्छ (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
सीमा (वैकल्पिक) प्रति पृष्ठ डेटा परिणाम
पृष्ठ (वैकल्पिक) हालको पृष्ठ अनुरोध
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"
            }
        ]
    }
}

पिक्सेल सिर्जना गर्नुहोस्

पोस्ट https://urlkai.com/api/pixel/add

यो अन्त्यबिन्दु प्रयोग गरेर पिक्सेल सिर्जना गर्न सकिन्छ । तपाईँले पिक्सेल प्रकार र ट्याग पठाउन आवश्यक छ ।

प्यारामिटर Beskrivelse
प्रकार (आवश्यक) जीटीएमपीएक्सेल | ग्यापिक्सेल | fbpixel | शब्दकोश | linkinpixel | ट्विटर पिक्सेल | adrollpixel | कोरापिक्सेल | पिन्टेरेस्ट | बिंग | स्न्यापच्याट | रेडिट | टिकटक
नाम (आवश्यक) तपाईँको पिक्सेलका लागि अनुकूल नाम
ट्याग (आवश्यक) पिक्सेलका लागि ट्याग
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

पुट https://urlkai.com/api/pixel/:id/update

पिक्सेल अद्यावधिक गर्न, तपाईँले पुट अनुरोध मार्फत जेएसओएनमा वैध डेटा पठाउनु पर्दछ। डेटा तल देखाइएको रूपमा तपाईंको अनुरोधको कच्चा शरीरको रूपमा पठाउनु पर्दछ। तलको उदाहरणले तपाईँले पठाउन सक्नुहुने सबै परिमितिहरू देखाउँदछ तर तपाईँलाई सबै पठाउन आवश्यक छैन (थप जानकारीको लागि तालिका हेर्नुहोस्)।

प्यारामिटर Beskrivelse
नाम (वैकल्पिक) तपाईँको पिक्सेलका लागि अनुकूल नाम
ट्याग (आवश्यक) पिक्सेलका लागि ट्याग
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."
}

पिक्सेल मेट्नुहोस्

मेट्नुहोस् https://urlkai.com/api/pixel/:id/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."
}