İçeriğe geç
Admin API

Client

Serverhttps://magaza-adiniz.myideasoft.com

Client LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/clients
Bearer
or
OAuth 2.0

Client LIST › query Parameters

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 gelecek Shipments adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

randomId
​string

random_id

name
​string

name

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Client LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

name
​string · maxLength: 255 · required

Client adı.

Example: IdeasoftApp
id
​integer

Client nesnesine ait benzersiz kimlik numarası.

Example: 1
randomId
​string · minLength: 1 · maxLength: 255

Client için rastgele oluşturulmuş benzersiz kimlik.

secret
​string · minLength: 1 · maxLength: 255

Client gizli anahtarı. API erişimlerinde kullanılır.

​object

Client'ın yönlendirme URI'ları.

​object

Client için izin verilen yetkilendirme türleri.

createdAt
​string · date-time

Client nesnesinin oluşturulma zamanı.

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

Client nesnesinin son güncellenme zamanı.

Example: 2022-10-20T10:15:30+03:00
predefined
​boolean

Client'ın ön tanımlı olup olmadığını belirtir

Example: false

Client POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/clients
Bearer
or
OAuth 2.0

Client POST › Request Body

name
​string · maxLength: 255 · required

Client adı.

Example: IdeasoftApp
id
​integer

Client nesnesine ait benzersiz kimlik numarası.

Example: 1
randomId
​string · minLength: 1 · maxLength: 255

Client için rastgele oluşturulmuş benzersiz kimlik.

secret
​string · minLength: 1 · maxLength: 255

Client gizli anahtarı. API erişimlerinde kullanılır.

​object

Client'ın yönlendirme URI'ları.

​object

Client için izin verilen yetkilendirme türleri.

createdAt
​string · date-time

Client nesnesinin oluşturulma zamanı.

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

Client nesnesinin son güncellenme zamanı.

Example: 2022-10-20T10:15:30+03:00
predefined
​boolean

Client'ın ön tanımlı olup olmadığını belirtir

Example: false

Client POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

name
​string · maxLength: 255 · required

Client adı.

Example: IdeasoftApp
id
​integer

Client nesnesine ait benzersiz kimlik numarası.

Example: 1
randomId
​string · minLength: 1 · maxLength: 255

Client için rastgele oluşturulmuş benzersiz kimlik.

secret
​string · minLength: 1 · maxLength: 255

Client gizli anahtarı. API erişimlerinde kullanılır.

​object

Client'ın yönlendirme URI'ları.

​object

Client için izin verilen yetkilendirme türleri.

createdAt
​string · date-time

Client nesnesinin oluşturulma zamanı.

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

Client nesnesinin son güncellenme zamanı.

Example: 2022-10-20T10:15:30+03:00
predefined
​boolean

Client'ın ön tanımlı olup olmadığını belirtir

Example: false

Client COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/clients/count
Bearer
or
OAuth 2.0

Client COUNT › query Parameters

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 gelecek Shipments adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

randomId
​string

random_id

name
​string

name

q
​string

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

s
​string

Arama anahtarı ile filtreleme.

Client COUNT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.


Client GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/clients/{id}
Bearer
or
OAuth 2.0

Client GET › path Parameters

id
​string · pattern: \d+ · required

Client GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

name
​string · maxLength: 255 · required

Client adı.

Example: IdeasoftApp
id
​integer

Client nesnesine ait benzersiz kimlik numarası.

Example: 1
randomId
​string · minLength: 1 · maxLength: 255

Client için rastgele oluşturulmuş benzersiz kimlik.

secret
​string · minLength: 1 · maxLength: 255

Client gizli anahtarı. API erişimlerinde kullanılır.

​object

Client'ın yönlendirme URI'ları.

​object

Client için izin verilen yetkilendirme türleri.

createdAt
​string · date-time

Client nesnesinin oluşturulma zamanı.

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

Client nesnesinin son güncellenme zamanı.

Example: 2022-10-20T10:15:30+03:00
predefined
​boolean

Client'ın ön tanımlı olup olmadığını belirtir

Example: false

Client PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/clients/{id}
Bearer
or
OAuth 2.0

Client PUT › path Parameters

id
​string · pattern: \d+ · required

Client PUT › Request Body

name
​string · maxLength: 255 · required

Client adı.

Example: IdeasoftApp
id
​integer

Client nesnesine ait benzersiz kimlik numarası.

Example: 1
randomId
​string · minLength: 1 · maxLength: 255

Client için rastgele oluşturulmuş benzersiz kimlik.

secret
​string · minLength: 1 · maxLength: 255

Client gizli anahtarı. API erişimlerinde kullanılır.

​object

Client'ın yönlendirme URI'ları.

​object

Client için izin verilen yetkilendirme türleri.

createdAt
​string · date-time

Client nesnesinin oluşturulma zamanı.

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

Client nesnesinin son güncellenme zamanı.

Example: 2022-10-20T10:15:30+03:00
predefined
​boolean

Client'ın ön tanımlı olup olmadığını belirtir

Example: false

Client PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

name
​string · maxLength: 255 · required

Client adı.

Example: IdeasoftApp
id
​integer

Client nesnesine ait benzersiz kimlik numarası.

Example: 1
randomId
​string · minLength: 1 · maxLength: 255

Client için rastgele oluşturulmuş benzersiz kimlik.

secret
​string · minLength: 1 · maxLength: 255

Client gizli anahtarı. API erişimlerinde kullanılır.

​object

Client'ın yönlendirme URI'ları.

​object

Client için izin verilen yetkilendirme türleri.

createdAt
​string · date-time

Client nesnesinin oluşturulma zamanı.

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

Client nesnesinin son güncellenme zamanı.

Example: 2022-10-20T10:15:30+03:00
predefined
​boolean

Client'ın ön tanımlı olup olmadığını belirtir

Example: false

Client DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/admin-api/clients/{id}
Bearer
or
OAuth 2.0

Client DELETE › path Parameters

id
​string · pattern: \d+ · required

Client DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned