Skip to content
Ideasoft
Admin API

Banner

Serverhttps://your-store.myideasoft.com

GET
https://your-store.myideasoft.com
/admin-api/banners
Bearer
or
OAuth 2.0
sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id.

limit
​integer · min: 1 · max: 100

Bir sayfada listelenecek banner adedi.

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası.

Default: 1
id
​integer · min: 1

Tekli listeleme için banner ID.

ids
​string

Çoklu listeleme için virgülle ayrılmış banner ID’leri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

q
​string

Banner arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

s
​string

Arama anahtarı ile filtreleme.

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Banner nesnesinin görünen adı.

Example: ana banner123
targetBlankStatus
​integer · enum · required

Banner bağlantısının yeni sekmede açılıp açılmayacağını belirten durum bilgisidir.( 0 = Aynı sekmede aç, 1 = Yeni sekmede aç) Seçenekler: | 0: Pasif (aynı sekmede açılır). | 1: Aktif (yeni sekmede açılır).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Banner nesnesinin aktif olup olmadığını belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
id
​integer

Banner nesnesine ait benzersiz kimlik (ID) değeri.

Example: 5
imageFile
​string

Banner nesnesine ait görselin dosya adıdır. Site hızı ve seo skorunuz için yüklemiş olduğunuz görselin JPG formatında olmasını öneriyoruz.

Example: banner.jpg
imageUrl
​string

Banner görselinin tam URL adresidir.

Example: //test.myideasoft.com/test/a/01/banner/banner.jpg
targetUrl
​string

Banner tıklandığında yönlendirme yapılacak bağlantı (URL) bilgisidir.

Example: https://www.ideasoft.com.tr/yardim/
altAttribute
​string · maxLength: 255

Banner nesnesine ait görselin alt etiketi (alternatif metin) değeridir.

Example: İdeasoft Yardım
attachment
​string · writeOnly

Banner dosyasına ait ek/medya nesnesi bilgisidir.

updatedAt
​string · date-time

Banner nesnesinin son güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Banner nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00

POST
https://your-store.myideasoft.com
/admin-api/banners
Bearer
or
OAuth 2.0
name
​string · maxLength: 255 · required

Banner nesnesinin görünen adı.

Example: ana banner123
targetBlankStatus
​integer · enum · required

Banner bağlantısının yeni sekmede açılıp açılmayacağını belirten durum bilgisidir.( 0 = Aynı sekmede aç, 1 = Yeni sekmede aç) Seçenekler: | 0: Pasif (aynı sekmede açılır). | 1: Aktif (yeni sekmede açılır).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Banner nesnesinin aktif olup olmadığını belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
id
​integer

Banner nesnesine ait benzersiz kimlik (ID) değeri.

Example: 5
imageFile
​string

Banner nesnesine ait görselin dosya adıdır. Site hızı ve seo skorunuz için yüklemiş olduğunuz görselin JPG formatında olmasını öneriyoruz.

Example: banner.jpg
imageUrl
​string

Banner görselinin tam URL adresidir.

Example: //test.myideasoft.com/test/a/01/banner/banner.jpg
targetUrl
​string

Banner tıklandığında yönlendirme yapılacak bağlantı (URL) bilgisidir.

Example: https://www.ideasoft.com.tr/yardim/
altAttribute
​string · maxLength: 255

Banner nesnesine ait görselin alt etiketi (alternatif metin) değeridir.

Example: İdeasoft Yardım
attachment
​string · writeOnly

Banner dosyasına ait ek/medya nesnesi bilgisidir.

updatedAt
​string · date-time

Banner nesnesinin son güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Banner nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00

The create request (POST) completed successfully.

name
​string · maxLength: 255 · required

Banner nesnesinin görünen adı.

Example: ana banner123
targetBlankStatus
​integer · enum · required

Banner bağlantısının yeni sekmede açılıp açılmayacağını belirten durum bilgisidir.( 0 = Aynı sekmede aç, 1 = Yeni sekmede aç) Seçenekler: | 0: Pasif (aynı sekmede açılır). | 1: Aktif (yeni sekmede açılır).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Banner nesnesinin aktif olup olmadığını belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
id
​integer

Banner nesnesine ait benzersiz kimlik (ID) değeri.

Example: 5
imageFile
​string

Banner nesnesine ait görselin dosya adıdır. Site hızı ve seo skorunuz için yüklemiş olduğunuz görselin JPG formatında olmasını öneriyoruz.

Example: banner.jpg
imageUrl
​string

Banner görselinin tam URL adresidir.

Example: //test.myideasoft.com/test/a/01/banner/banner.jpg
targetUrl
​string

Banner tıklandığında yönlendirme yapılacak bağlantı (URL) bilgisidir.

Example: https://www.ideasoft.com.tr/yardim/
altAttribute
​string · maxLength: 255

Banner nesnesine ait görselin alt etiketi (alternatif metin) değeridir.

Example: İdeasoft Yardım
attachment
​string · writeOnly

Banner dosyasına ait ek/medya nesnesi bilgisidir.

updatedAt
​string · date-time

Banner nesnesinin son güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Banner nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00

GET
https://your-store.myideasoft.com
/admin-api/banners/count
Bearer
or
OAuth 2.0
sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id.

limit
​integer · min: 1 · max: 100

Bir sayfada listelenecek banner adedi.

Default: 20
page
​integer · min: 1

Başlanacak sayfa numarası.

Default: 1
id
​integer · min: 1

Tekli listeleme için banner ID.

ids
​string

Çoklu listeleme için virgülle ayrılmış banner ID’leri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID’den sonraki kayıtları getirir.

q
​string

Banner arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

s
​string

Arama anahtarı ile filtreleme.

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


GET
https://your-store.myideasoft.com
/admin-api/banners/{id}
Bearer
or
OAuth 2.0
id
​string · pattern: \d+ · required

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Banner nesnesinin görünen adı.

Example: ana banner123
targetBlankStatus
​integer · enum · required

Banner bağlantısının yeni sekmede açılıp açılmayacağını belirten durum bilgisidir.( 0 = Aynı sekmede aç, 1 = Yeni sekmede aç) Seçenekler: | 0: Pasif (aynı sekmede açılır). | 1: Aktif (yeni sekmede açılır).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Banner nesnesinin aktif olup olmadığını belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
id
​integer

Banner nesnesine ait benzersiz kimlik (ID) değeri.

Example: 5
imageFile
​string

Banner nesnesine ait görselin dosya adıdır. Site hızı ve seo skorunuz için yüklemiş olduğunuz görselin JPG formatında olmasını öneriyoruz.

Example: banner.jpg
imageUrl
​string

Banner görselinin tam URL adresidir.

Example: //test.myideasoft.com/test/a/01/banner/banner.jpg
targetUrl
​string

Banner tıklandığında yönlendirme yapılacak bağlantı (URL) bilgisidir.

Example: https://www.ideasoft.com.tr/yardim/
altAttribute
​string · maxLength: 255

Banner nesnesine ait görselin alt etiketi (alternatif metin) değeridir.

Example: İdeasoft Yardım
attachment
​string · writeOnly

Banner dosyasına ait ek/medya nesnesi bilgisidir.

updatedAt
​string · date-time

Banner nesnesinin son güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Banner nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00

PUT
https://your-store.myideasoft.com
/admin-api/banners/{id}
Bearer
or
OAuth 2.0
id
​string · pattern: \d+ · required
name
​string · maxLength: 255 · required

Banner nesnesinin görünen adı.

Example: ana banner123
targetBlankStatus
​integer · enum · required

Banner bağlantısının yeni sekmede açılıp açılmayacağını belirten durum bilgisidir.( 0 = Aynı sekmede aç, 1 = Yeni sekmede aç) Seçenekler: | 0: Pasif (aynı sekmede açılır). | 1: Aktif (yeni sekmede açılır).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Banner nesnesinin aktif olup olmadığını belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
id
​integer

Banner nesnesine ait benzersiz kimlik (ID) değeri.

Example: 5
imageFile
​string

Banner nesnesine ait görselin dosya adıdır. Site hızı ve seo skorunuz için yüklemiş olduğunuz görselin JPG formatında olmasını öneriyoruz.

Example: banner.jpg
imageUrl
​string

Banner görselinin tam URL adresidir.

Example: //test.myideasoft.com/test/a/01/banner/banner.jpg
targetUrl
​string

Banner tıklandığında yönlendirme yapılacak bağlantı (URL) bilgisidir.

Example: https://www.ideasoft.com.tr/yardim/
altAttribute
​string · maxLength: 255

Banner nesnesine ait görselin alt etiketi (alternatif metin) değeridir.

Example: İdeasoft Yardım
attachment
​string · writeOnly

Banner dosyasına ait ek/medya nesnesi bilgisidir.

updatedAt
​string · date-time

Banner nesnesinin son güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Banner nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00

The request (GET or PUT) completed successfully.

name
​string · maxLength: 255 · required

Banner nesnesinin görünen adı.

Example: ana banner123
targetBlankStatus
​integer · enum · required

Banner bağlantısının yeni sekmede açılıp açılmayacağını belirten durum bilgisidir.( 0 = Aynı sekmede aç, 1 = Yeni sekmede aç) Seçenekler: | 0: Pasif (aynı sekmede açılır). | 1: Aktif (yeni sekmede açılır).

Enum values:
0
1
Example: 1
status
​integer · enum · required

Banner nesnesinin aktif olup olmadığını belirtir. (0 = Pasif, 1 = Aktif) Seçenekler: | 0: Pasif. | 1: Aktif.

Enum values:
0
1
Example: 1
id
​integer

Banner nesnesine ait benzersiz kimlik (ID) değeri.

Example: 5
imageFile
​string

Banner nesnesine ait görselin dosya adıdır. Site hızı ve seo skorunuz için yüklemiş olduğunuz görselin JPG formatında olmasını öneriyoruz.

Example: banner.jpg
imageUrl
​string

Banner görselinin tam URL adresidir.

Example: //test.myideasoft.com/test/a/01/banner/banner.jpg
targetUrl
​string

Banner tıklandığında yönlendirme yapılacak bağlantı (URL) bilgisidir.

Example: https://www.ideasoft.com.tr/yardim/
altAttribute
​string · maxLength: 255

Banner nesnesine ait görselin alt etiketi (alternatif metin) değeridir.

Example: İdeasoft Yardım
attachment
​string · writeOnly

Banner dosyasına ait ek/medya nesnesi bilgisidir.

updatedAt
​string · date-time

Banner nesnesinin son güncellenme tarihi.

Example: 2022-04-20T14:33:45+03:00
createdAt
​string · date-time

Banner nesnesinin oluşturulma tarihi.

Example: 2022-04-20T14:33:45+03:00

DELETE
https://your-store.myideasoft.com
/admin-api/banners/{id}
Bearer
or
OAuth 2.0
id
​string · pattern: \d+ · required

The delete request completed successfully (the response has no content).

No data returned