Developers

開発者向け API リファレンス

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.

Slag

Een API-sleutel is vereist om aanvragen door het systeem te kunnen verwerken. Zodra een gebruiker zich registreert, wordt er automatisch een API-sleutel gegenereerd voor deze gebruiker. De API-sleutel moet bij elk verzoek worden meegestuurd (zie het volledige voorbeeld hieronder). Als de API-sleutel niet wordt verzonden of is verlopen, treedt er een fout op. Zorg ervoor dat u uw API-sleutel geheim houdt om misbruik te voorkomen.

Authenticatie

Als u zich wilt verifiëren bij het API-systeem, moet u uw API-sleutel bij elke aanvraag als autorisatietoken verzenden. U kunt de voorbeeldcode hieronder zien.

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

Tarief limiet

Onze API heeft een snelheidsbegrenzer om te beschermen tegen pieken in verzoeken om de stabiliteit te maximaliseren. Onze snelheidsbegrenzer is momenteel beperkt tot 30 verzoeken per 1 minuut. Houd er rekening mee dat het tarief kan veranderen afhankelijk van het geabonneerde abonnement.

Samen met het antwoord worden verschillende headers verzonden en deze kunnen worden onderzocht om verschillende informatie over het verzoek te bepalen.

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

Afhandeling van reacties

Alle API-responsen worden standaard geretourneerd in JSON-indeling. Om dit om te zetten in bruikbare gegevens, moet de juiste functie worden gebruikt, afhankelijk van de taal. In PHP kan de functie json_decode() worden gebruikt om de gegevens te converteren naar een object (standaard) of een array (stel de tweede parameter in op true). Het is erg belangrijk om de foutsleutel te controleren, omdat deze informatie geeft over of er een fout is opgetreden of niet. U kunt ook de koptekstcode controleren.

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

Rekening

Account krijgen

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

Als u informatie over het account wilt krijgen, kunt u een verzoek naar dit eindpunt sturen en worden er gegevens over het account geretourneerd.

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

Antwoord van de server

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

Account bijwerken

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

Als u de informatie over het account wilt bijwerken, kunt u een verzoek naar dit eindpunt sturen, waarna de gegevens op het account worden bijgewerkt.

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

Antwoord van de server

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

Merkgebonden domeinen

Vermeld merkdomeinen

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

Om uw merkdomeinen via de API te krijgen, kunt u dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

{
    "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"
            }
        ]
    }
}

Maak een merkdomein

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

Met behulp van dit eindpunt kan een domein worden toegevoegd. Zorg ervoor dat het domein correct naar onze server verwijst.

Parameter Beschrijving
domein (verplicht) Merkdomein inclusief http of https
Root omleiden (optioneel) Root-omleiding wanneer iemand uw domein bezoekt
doorverwijzen 404 (optioneel) Aangepaste 404-omleiding
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"
}'

Antwoord van de server

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

ドメインを更新

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

Als u een merkdomein wilt bijwerken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
Root omleiden (optioneel) Root-omleiding wanneer iemand uw domein bezoekt
doorverwijzen 404 (optioneel) Aangepaste 404-omleiding
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"
}'

Antwoord van de server

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

Domein verwijderen

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

Als u een domein wilt verwijderen, moet u een DELETE-verzoek verzenden.

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

Antwoord van de server

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

CTA-overlays

Lijst CTA-overlays

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

Om cta-overlays via de API te krijgen, kunt u dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

{
    "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"
            }
        ]
    }
}

Aangepaste Splash

Lijst Aangepaste Splash

TOEVOEGEN 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 Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

{
    "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"
            }
        ]
    }
}

Bestanden

Lijstbestanden

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

Haal al je dossiers. Je kunt ook zoeken op naam.

Parameter Beschrijving
naam (optioneel) Zoek naar een bestand op naam
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

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

Upload een bestand

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

Upload een bestand door de binaire data als postinhoud te verzenden. Je moet de bestandsnaam met de extensie in plaats van :filename in de url (bijvoorbeeld brandkit.zip) sturen. Je kunt opties instellen door de volgende parameters in te sturen.

Parameter Beschrijving
naam (optioneel) Bestandsnaam
gewoonte (optioneel) Aangepaste alias in plaats van willekeurige alias.
domein (optioneel) Aangepast domein
wachtwoord (optioneel) Wachtwoord beveiliging
Verstrijken (optioneel) Vervaldatum voor het downloadvoorbeeld 2021-09-28
maxdownloads (optioneel) Maximaal aantal downloads
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'

Antwoord van de server

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

QRコード

Lijst QR-codes

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

Om je QR-codes via de API te krijgen, kun je dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

{
    "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"
            }
        ]
    }
}

Ontvang een enkele QR-code

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

Om via de API details te krijgen voor een enkele QR-code, kunt u dit eindpunt gebruiken.

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

Antwoord van de server

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

Maak een QR-code

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

Om een QR-code te maken, moet u geldige gegevens in JSON verzenden via een POST-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
type (verplichte) tekst | vcard | koppeling | E-mailadres | telefoon | sms | Wifi
gegevens (verplicht) Gegevens die in de QR-code moeten worden ingesloten. De gegevens kunnen een string of array zijn, afhankelijk van het type
achtergrond (optioneel) RGB-kleur, bijv. rgb (255.255.255)
voorgrond (optioneel) RGB-kleur, bijv. rgb(0,0,0)
logo (optioneel) Pad naar het logo, png of jpg
naam (optioneel) Naam QR-code
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"
}'

Antwoord van de server

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

QR-code bijwerken

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

Om een QR-code bij te werken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
gegevens (verplicht) Gegevens die in de QR-code moeten worden ingesloten. De gegevens kunnen een string of array zijn, afhankelijk van het type
achtergrond (optioneel) RGB-kleur, bijv. rgb (255.255.255)
voorgrond (optioneel) RGB-kleur, bijv. rgb(0,0,0)
logo (optioneel) Pad naar het logo, png of 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"
}'

Antwoord van de server

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

Een QR-code verwijderen

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

Om een QR-code te verwijderen, moet u een DELETE-verzoek verzenden.

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

Antwoord van de server

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

キャンペーン

Campagnes weergeven

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

Om je campagnes via de API te krijgen, kun je dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

{
    "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"
            }
        ]
    }
}

Een campagne maken

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

Met behulp van dit eindpunt kan een campagne worden toegevoegd.

Parameter Beschrijving
naam (optioneel) Naam van de campagne
naaktslak (optioneel) Rotator naaktslak
publiek (optioneel) Toegang
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
}'

Antwoord van de server

{
    "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"
}
VERZENDEN https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Met behulp van dit eindpunt kan een korte link aan een campagne worden toegewezen. Voor het eindpunt zijn de campagne-ID en de korte link-ID vereist.

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

Antwoord van de server

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

キャンペーンの更新

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

Om een campagne bij te werken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
naam (verplicht) Naam van de campagne
naaktslak (optioneel) Rotator naaktslak
publiek (optioneel) Toegang
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
}'

Antwoord van de server

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

Campagne verwijderen

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

Als u een campagne wilt verwijderen, moet u een DELETE-verzoek verzenden.

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

Antwoord van de server

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

チャンネル一覧

Lijst Kanalen

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

Om je kanalen via de API te krijgen, kun je dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

{
    "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
            }
        ]
    }
}

Lijst van kanaalitems

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

Om items in een bepaald kanaal via de API te krijgen, kunt u dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

{
    "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"
            }
        ]
    }
}

Een kanaal maken

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

Met behulp van dit eindpunt kan een kanaal worden toegevoegd.

Parameter Beschrijving
naam (verplicht) Naam van het kanaal
beschrijving (optioneel) Beschrijving van het kanaal
Kleur (optioneel) Kleur kanaalbadge (HEX)
Speelde (optioneel) Het kanaal een ster geven of niet (waar of niet waar)
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
}'

Antwoord van de server

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

Een item aan een kanaal toewijzen

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

Een item kan aan elk kanaal worden toegewezen door een verzoek te sturen met de kanaal-ID, het itemtype (links, bio of qr) en de item-ID.

Parameter Beschrijving
:kanaalid (verplicht) Kanaal-ID
:type (verplichte) links of bio of QR
:itemid (verplicht) Artikel-ID
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

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

Kanaal bijwerken

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

Als u een kanaal wilt bijwerken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
naam (optioneel) Naam van het kanaal
beschrijving (optioneel) Beschrijving van het kanaal
Kleur (optioneel) Kleur kanaalbadge (HEX)
Speelde (optioneel) Het kanaal een ster geven of niet (waar of niet waar)
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
}'

Antwoord van de server

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

Kanaal verwijderen

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

Als je een kanaal wilt verwijderen, moet je een DELETE-verzoek verzenden. Alle items worden ook niet toegewezen.

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

Antwoord van de server

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

ピクセル

Lijst pixels

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

Om je pixelcodes via de API te krijgen, kun je dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Antwoord van de server

{
    "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"
            }
        ]
    }
}

Een pixel maken

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

Met behulp van dit eindpunt kan een pixel worden gemaakt. U moet het pixeltype en de tag verzenden.

Parameter Beschrijving
type (verplicht) gtmpixel | Gapixel | fbpixel | adwordspixel | linkedinpixel | Twitteren Pixel | adrollpixel | Quorapixel | Pinterest Nederland | Bing Nederland | Snapchat | Reddit | Tiktok
naam (verplicht) Aangepaste naam voor je pixel
label (verplicht) De tag voor de 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"
}'

Antwoord van de server

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

ピクセルを更新する

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

Als u een pixel wilt bijwerken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
naam (optioneel) Aangepaste naam voor je pixel
label (verplicht) De tag voor de 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"
}'

Antwoord van de server

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

Pixel verwijderen

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

Als u een pixel wilt verwijderen, moet u een DELETE-verzoek verzenden.

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

Antwoord van de server

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