Developers

Geliştiriciler için API Referansı

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.

Başlamak

Sistem tarafından taleplerin işlenmesi için bir API anahtarı gereklidir. Bir kullanıcı kayıt yaptırdıktan sonra, bu kullanıcı için otomatik olarak bir API anahtarı oluşturulur. API anahtarı her istekle birlikte gönderilmelidir (aşağıdaki tam örneke bakınız). API anahtarı gönderilmezse veya süresi dolmuşsa hata olur. Lütfen API anahtarınızı kötüye kullanmayı önlemek için gizli tutun.

Doğrulama

API sistemiyle kimlik doğrulaması için, her istekle birlikte API anahtarınızı yetkilendirme belirteci olarak göndermeniz gerekir. Aşağıda örnek kodu görebilirsiniz.

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

Oran Sınırı

API'mizde, taleplerde artışa karşı istikrarı maksimize etmek için bir hız sınırlayıcısı var. Tarife sınırlayıcımız şu anda 1 dakikada 30 talep ile sınırlandırılmış. Abone plana göre fiyatın değişebileceğini lütfen unutmayın.

Yanıtla birlikte birkaç başlık gönderilir ve bunlar talep hakkında çeşitli bilgiler belirlemek için incelenebilir.

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

Yanıt Yönetimi

Tüm API yanıtları varsayılan olarak JSON formatında döner. Bunu kullanılabilir veriye dönüştürmek için, uygun fonksiyonun dile göre kullanılması gerekir. PHP'de, json_decode() fonksiyonu veriyi ya bir nesneye (varsayılan) ya da bir diziye (ikinci parametreyi doğru olarak ayarla) dönüştürmek için kullanılabilir. Hata anahtarını kontrol etmek çok önemlidir çünkü bu, hata olup olmadığını gösterir. Başlık kodunu da kontrol edebilirsiniz.

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

Hesap Al

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

Hesap hakkında bilgi almak için bu uç noktaya bir istek gönderebilirsiniz ve bu, hesaptaki verileri döndürür.

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

Sunucu yanıtı

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

Hesabı Güncelle

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

Hesaptaki bilgileri güncelleştirmek için bu uç noktaya bir istek gönderebilirsiniz ve bu, hesaptaki verileri güncelleştirir.

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

Sunucu yanıtı

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

Markalı Alan Adları

Markalı Alan Adlarını Listele

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

Markalı alan adlarınızı API aracılığıyla almak için bu uç noktayı kullanabilirsiniz. Ayrıca verileri filtreleyebilirsiniz (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Markalı Bir Alan Adı Oluşturun

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

Bu uç nokta kullanılarak bir etki alanı eklenebilir. Lütfen alan adının sunucumuza doğru bir şekilde yönlendirildiğinden emin olun.

Parametre Açıklama
alan (gerekli) http veya https dahil olmak üzere markalı alan adı
Yönlendirme Kökü (isteğe bağlı) Birisi etki alanınızı ziyaret ettiğinde kök yönlendirmesi
yönlendirme404 (isteğe bağlı) Özel 404 yönlendirmesi
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"
}'

Sunucu yanıtı

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

Alan Güncellemesi

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

Markalı bir alan adını güncellemek için PUT isteği aracılığıyla JSON formatında geçerli bir veri göndermeniz gerekir. Veriler, aşağıda gösterildiği gibi talebinizin ham gövdesi olarak gönderilmelidir. Aşağıdaki örnek, gönderebileceğiniz tüm parametreleri gösterir, ancak tümünü göndermeniz gerekmez (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
Yönlendirme Kökü (isteğe bağlı) Birisi etki alanınızı ziyaret ettiğinde kök yönlendirmesi
yönlendirme404 (isteğe bağlı) Özel 404 yönlendirmesi
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"
}'

Sunucu yanıtı

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

Etki Alanını Sil

SİLMEK https://urlkai.com/api/domain/:id/delete

Bir alan adını silmek için bir DELETE isteği göndermeniz gerekir.

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

Sunucu yanıtı

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

CTA Kaplamaları

CTA Bindirmelerini Listeleyin

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

API aracılığıyla cta katmanları almak için bu uç noktayı kullanabilirsiniz. Ayrıca verileri filtreleyebilirsiniz (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Kampanya

Liste Kampanyaları

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

Kampanyalarınızı API üzerinden almak için bu uç noktayı kullanabilirsiniz. Ayrıca verileri filtreleyebilirsiniz (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Bir Kampanya Oluşturun

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

Bu uç nokta kullanılarak bir kampanya eklenebilir.

Parametre Açıklama
ad (isteğe bağlı) Kampanya adı
sümüklüböcek (isteğe bağlı) Döndürücü Sümüklü Böcek
kamu (isteğe bağlı) Erişim
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
}'

Sunucu yanıtı

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

Bu uç nokta kullanılarak bir kampanyaya kısa bir bağlantı atanabilir. Uç nokta, kampanya kimliğini ve kısa bağlantı kimliğini gerektirir.

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

Sunucu yanıtı

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

Güncelleme Kampanyası

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

Bir kampanyayı güncellemek için bir PUT isteği aracılığıyla JSON biçiminde geçerli bir veri göndermeniz gerekir. Veriler, aşağıda gösterildiği gibi talebinizin ham gövdesi olarak gönderilmelidir. Aşağıdaki örnek, gönderebileceğiniz tüm parametreleri gösterir, ancak tümünü göndermeniz gerekmez (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
ad (gerekli) Kampanya adı
sümüklüböcek (isteğe bağlı) Döndürücü Sümüklü Böcek
kamu (isteğe bağlı) Erişim
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
}'

Sunucu yanıtı

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

Kampanyayı Sil

SİLMEK https://urlkai.com/api/campaign/:id/delete

Bir kampanyayı silmek için bir DELETE isteği göndermeniz gerekir.

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

Sunucu yanıtı

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

Kanalları Listele

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

Kanallarınızı API aracılığıyla almak için bu uç noktayı kullanabilirsiniz. Ayrıca verileri filtreleyebilirsiniz (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Kanal Öğelerini Listeleme

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

API aracılığıyla belirli kanallardaki öğeleri almak için bu uç noktayı kullanabilirsiniz. Ayrıca verileri filtreleyebilirsiniz (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Bir Kanal Oluşturun

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

Bu uç nokta kullanılarak bir kanal eklenebilir.

Parametre Açıklama
ad (gerekli) Kanal adı
Açıklama (isteğe bağlı) Kanal açıklaması
Renk (isteğe bağlı) Kanal rozeti rengi (HEX)
Oynadı (isteğe bağlı) Kanala yıldız ekleme veya ekleme (doğru veya yanlış)
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
}'

Sunucu yanıtı

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

Kanala öğe atama

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

Bir öğe, kanal kimliği, öğe türü (bağlantılar, biyografi veya qr) ve öğe kimliği ile bir istek gönderilerek herhangi bir kanala atanabilir.

Parametre Açıklama
:kanal kimliği (gerekli) Kanal Kimliği
:tür (Gerekli) bağlantılar veya biyografi veya QR
:itemid (gerekli) Öğe Kimliği
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Güncelleme Kanalı

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

Bir kanalı güncellemek için PUT isteği aracılığıyla JSON'da geçerli bir veri göndermeniz gerekir. Veriler, aşağıda gösterildiği gibi talebinizin ham gövdesi olarak gönderilmelidir. Aşağıdaki örnek, gönderebileceğiniz tüm parametreleri gösterir, ancak tümünü göndermeniz gerekmez (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
ad (isteğe bağlı) Kanal adı
Açıklama (isteğe bağlı) Kanal açıklaması
Renk (isteğe bağlı) Kanal rozeti rengi (HEX)
Oynadı (isteğe bağlı) Kanala yıldız ekleme veya ekleme (doğru veya yanlış)
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
}'

Sunucu yanıtı

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

Kanalı Sil

SİLMEK https://urlkai.com/api/channel/:id/delete

Bir kanalı silmek için bir DELETE isteği göndermeniz gerekir. Tüm öğeler de atanmamış olacaktır.

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

Sunucu yanıtı

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

Özel Splash

Özel Splash'ı Listele

AL 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).

Parametre Açıklama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Dosyalar

Liste Dosyaları

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

Tüm dosyalarınızı alın. İsme göre de arama yapabilirsiniz.

Parametre Açıklama
ad (isteğe bağlı) Bir dosyayı isimle arama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Dosya yükle

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

Gönderi gövdesi olarak ikili veri göndererek bir dosya yükleyin. URL'de :filename yerine uzantı içeren dosya adını göndermeniz gerekiyor (örneğin brandkit.zip). Aşağıdaki parametreleri göndererek seçenekleri ayarlayabilirsiniz.

Parametre Açıklama
ad (isteğe bağlı) Dosya adı
töre (isteğe bağlı) Rastgele takma ad yerine özel takma ad.
alan (isteğe bağlı) Özel Etki Alanı
parola (isteğe bağlı) Parola koruması
Bitiş (isteğe bağlı) İndirme örneği için son kullanma tarihi 2021-09-28
maxdownloads (isteğe bağlı) Maksimum indirme sayısı
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"'

Sunucu yanıtı

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

Liste Pikselleri

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

Piksel kodlarınızı API aracılığıyla almak için bu uç noktayı kullanabilirsiniz. Ayrıca verileri filtreleyebilirsiniz (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Bir Piksel Oluşturun

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

Bu uç nokta kullanılarak bir piksel oluşturulabilir. Piksel türünü ve etiketi göndermeniz gerekir.

Parametre Açıklama
tür (Gerekli) GTMPIXEL | Gapiksel | fbpixel | AdwordsPixel | Linkedinpiksel | Twitter Pikseli | reklam pikseli | quorapixel | Pinterest | Bing | Snapchat | Reddit | Tiktok Tanıtımı
ad (gerekli) Pikseliniz için özel ad
etiket (gerekli) Pikselin etiketi
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"
}'

Sunucu yanıtı

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

Pixel'i Güncelle

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

Bir pikseli güncellemek için PUT isteği aracılığıyla JSON formatında geçerli bir veri göndermeniz gerekir. Veriler, aşağıda gösterildiği gibi talebinizin ham gövdesi olarak gönderilmelidir. Aşağıdaki örnek, gönderebileceğiniz tüm parametreleri gösterir, ancak tümünü göndermeniz gerekmez (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
ad (isteğe bağlı) Pikseliniz için özel ad
etiket (gerekli) Pikselin etiketi
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"
}'

Sunucu yanıtı

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

Pixel'i Sil

SİLMEK https://urlkai.com/api/pixel/:id/delete

Bir pikseli silmek için bir DELETE talebi göndermeniz gerekir.

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

Sunucu yanıtı

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

QR Kodları

QR kodlarını listeleyin

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

QR kodlarınızı API aracılığıyla almak için bu uç noktayı kullanabilirsiniz. Ayrıca verileri filtreleyebilirsiniz (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
sınırlamak (isteğe bağlı) Sayfa başına veri sonucu
sayfa (isteğe bağlı) Geçerli sayfa isteği
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

Sunucu yanıtı

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

Tek bir QR Kodu alın

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

API aracılığıyla tek bir QR kodunun ayrıntılarını almak için bu uç noktayı kullanabilirsiniz.

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

Sunucu yanıtı

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

Bir QR Kodu Oluşturun

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

Bir QR Kodu oluşturmak için, bir POST isteği aracılığıyla JSON içinde geçerli bir veri göndermeniz gerekir. Veriler, aşağıda gösterildiği gibi talebinizin ham gövdesi olarak gönderilmelidir. Aşağıdaki örnek, gönderebileceğiniz tüm parametreleri gösterir, ancak tümünü göndermeniz gerekmez (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
tür (Gerekli) Metin | vCard | bağlantı | E-posta | Telefon | SMS | kablosuz internet bağlantısı
veri (gerekli) QR kodunun içine gömülecek veriler. Veriler, türe bağlı olarak dize veya dizi olabilir
arka plan (isteğe bağlı) RGB rengi, örneğin rgb(255,255,255)
Ön plan (isteğe bağlı) RGB rengi, örneğin rgb(0,0,0)
logo (isteğe bağlı) Logoya giden yol: png veya jpg
ad (isteğe bağlı) QR Kod adı
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"
}'

Sunucu yanıtı

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

QR Kodunu Güncelle

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

Bir QR Kodunu güncellemek için, bir PUT isteği aracılığıyla JSON içinde geçerli bir veri göndermeniz gerekir. Veriler, aşağıda gösterildiği gibi talebinizin ham gövdesi olarak gönderilmelidir. Aşağıdaki örnek, gönderebileceğiniz tüm parametreleri gösterir, ancak tümünü göndermeniz gerekmez (Daha fazla bilgi için tabloya bakın).

Parametre Açıklama
veri (gerekli) QR kodunun içine gömülecek veriler. Veriler, türe bağlı olarak dize veya dizi olabilir
arka plan (isteğe bağlı) RGB rengi, örneğin rgb(255,255,255)
Ön plan (isteğe bağlı) RGB rengi, örneğin rgb(0,0,0)
logo (isteğe bağlı) Logoya giden yol: png veya 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"
}'

Sunucu yanıtı

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

QR Kodunu Silme

SİLMEK https://urlkai.com/api/qr/:id/delete

Bir QR kodunu silmek için bir DELETE isteği göndermeniz gerekir.

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

Sunucu yanıtı

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