Linkler

Notlar

Uzman Seviyesi

API anahtarı, isteğin Authorization başlığında Bearer token olarak gönderilmelidir. API anahtarınızı alın.

Liste

API Uç Noktası:

GET

https://urlkisa.tr/api/v1/links

İstek Örneği:

curl --location --request GET 'https://urlkisa.tr/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parametre

Tip

Açıklama

search

i̇steğe bağlı string

Arama sorgusu.

search_by

i̇steğe bağlı string

Şuna Göre Ara. Olası değerler: Başlık için title, Takma Ad için alias, URL için url. Varsayılan: title.

status

i̇steğe bağlı integer

Duruma göre filtrele. Olası değerler: Tümü için 0, Aktif için 1, Süresi Dolmuş için 2, Devre Dışı için 3. Varsayılan: 0.

space_id

i̇steğe bağlı integer

Alan ID'sine göre filtrele.

domain_id

i̇steğe bağlı integer

Domain ID'sine göre filtrele.

pixel_id

i̇steğe bağlı integer

Piksel ID'sine göre filtrele.

sort_by

i̇steğe bağlı string

Şuna Göre Sırala. Olası değerler: Oluşturulma Tarihi için id, Tıklamalar için clicks, Başlık için title, Takma Ad için alias, URL için url. Varsayılan: id.

sort

i̇steğe bağlı string

Sırala. Olası değerler: Azalan için desc, Artan için asc. Varsayılan: desc.

per_page

i̇steğe bağlı integer

Sayfa başına sonuç. Olası değerler: 10, 25, 50, 100. Varsayılan: 10.

Göster

API Uç Noktası:

GET

https://urlkisa.tr/api/v1/links/{id}

İstek Örneği:

curl --location --request GET 'https://urlkisa.tr/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Sakla

API Uç Noktası:

POST

https://urlkisa.tr/api/v1/links

İstek Örneği:

curl --location --request POST 'https://urlkisa.tr/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'

Parametre

Tip

Açıklama

url

gerekli string

Kısaltılacak link.

domain_id

gerekli integer

Linkin kaydedileceği domain ID'si.

alias

i̇steğe bağlı string

Link takma adı.

password

i̇steğe bağlı string

Link şifresi.

space_id

i̇steğe bağlı integer

Linkin kaydedileceği alan ID'si.

pixel_ids

i̇steğe bağlı array

The pixel IDs to be integrated in the link.

disabled

i̇steğe bağlı integer

Linkin devre dışı olup olmadığı. Olası değerler: Aktif için 0, Devre Dışı için 1. Varsayılan: 0.

privacy

i̇steğe bağlı integer

Link istatistiklerinin herkese açık olup olmadığı. Olası değerler: Herkese Açık için 0, Özel için 1, Şifre için 2. Varsayılan: 0.

privacy_password

i̇steğe bağlı string

İstatistik sayfası için şifre. Yalnızca privacy 2 olarak ayarlandığında çalışır.

expiration_url

i̇steğe bağlı string

Linkin süresi dolduğunda kullanıcının yönlendirileceği link.

expiration_date

i̇steğe bağlı string

YYYY-MM-DD formatında link son kullanma tarihi.

expiration_time

i̇steğe bağlı string

HH:MM formatında link son kullanma saati.

expiration_clicks

i̇steğe bağlı integer

Linkin süresi dolması gereken tıklama sayısı.

target_type

i̇steğe bağlı integer

Hedefleme türü. Olası değerler: Hiçbiri için 0, Coğrafi için 1, Platform için 2, Rotasyon için 4.

country[index][key]

i̇steğe bağlı string

Hedeflenen ülkenin kodu. Kod ISO 3166-1 alpha-2 standardında olmalıdır.

country[index][value]

i̇steğe bağlı string

Kullanıcının yönlendirileceği link.

platform[index][key]

i̇steğe bağlı string

Hedeflenen platformun adı. Olası değerler: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

platform[index][value]

i̇steğe bağlı string

Kullanıcının yönlendirileceği link.

language[index][key]

i̇steğe bağlı string

Hedeflenen dilin kodu. Kod ISO 639-1 alpha-2 standardında olmalıdır.

language[index][value]

i̇steğe bağlı string

Kullanıcının yönlendirileceği link.

rotation[index][value]

i̇steğe bağlı string

Kullanıcının yönlendirileceği link.

Güncelle

API Uç Noktası:

PUT PATCH

https://urlkisa.tr/api/v1/links/{id}

İstek Örneği:

curl --location --request PUT 'https://urlkisa.tr/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

Parametre

Tip

Açıklama

url

i̇steğe bağlı string

Kısaltılacak link.

alias

i̇steğe bağlı string

Link takma adı.

password

i̇steğe bağlı string

Link şifresi.

space_id

i̇steğe bağlı integer

Linkin kaydedileceği alan ID'si.

pixel_ids

i̇steğe bağlı array

The pixel IDs to be integrated in the link.

disabled

i̇steğe bağlı integer

Linkin devre dışı olup olmadığı. Olası değerler: Aktif için 0, Devre Dışı için 1.

privacy

i̇steğe bağlı integer

Link istatistiklerinin herkese açık olup olmadığı. Olası değerler: Herkese Açık için 0, Özel için 1, Şifre için 2.

privacy_password

i̇steğe bağlı string

İstatistik sayfası için şifre. Yalnızca privacy 2 olarak ayarlandığında çalışır.

expiration_url

i̇steğe bağlı string

Linkin süresi dolduğunda kullanıcının yönlendirileceği link.

expiration_date

i̇steğe bağlı string

YYYY-MM-DD formatında link son kullanma tarihi.

expiration_time

i̇steğe bağlı string

HH:MM formatında link son kullanma saati.

expiration_clicks

i̇steğe bağlı integer

Linkin süresi dolması gereken tıklama sayısı.

target_type

i̇steğe bağlı integer

Hedefleme türü. Olası değerler: Hiçbiri için 0, Coğrafi için 1, Platform için 2, Rotasyon için 4.

country[index][key]

i̇steğe bağlı string

Hedeflenen ülkenin kodu. Kod ISO 3166-1 alpha-2 standardında olmalıdır.

country[index][value]

i̇steğe bağlı string

Kullanıcının yönlendirileceği link.

platform[index][key]

i̇steğe bağlı string

Hedeflenen platformun adı. Olası değerler: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

platform[index][value]

i̇steğe bağlı string

Kullanıcının yönlendirileceği link.

language[index][key]

i̇steğe bağlı string

Hedeflenen dilin kodu. Kod ISO 639-1 alpha-2 standardında olmalıdır.

language[index][value]

i̇steğe bağlı string

Kullanıcının yönlendirileceği link.

rotation[index][value]

i̇steğe bağlı string

Kullanıcının yönlendirileceği link.

Sil

API Uç Noktası:

DELETE

https://urlkisa.tr/api/v1/links/{id}

İstek Örneği:

curl --location --request DELETE 'https://urlkisa.tr/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'