SelSup Developers

Halk API · API İpucu

Anahtar kelimeler

Anahtar kelime için kesin yollar, parametreler, talep organları ve genişletilebilir cevap şemeleri dahil olmak üzere son noktalar.

12 Son noktaları/api/keywordDayanıklıMakine okuyabilir açıklama ↗
{ }

Bu sayfa düzenlenebilir bir bağımsız sözleşme ile desteklenir.

/api/keyword

Kullanılabilir iş akışları

Kullanılabilir iş akışları

Verim modeli

Veriler yapısı

Modeller burada bir kez listelenmiştir ve bunları kullanan uç noktalardan doğrudan genişletilebilir.

Keyword3 alanlar
idinteger · int64

Id.

namestring

Adı.

usingQuantityinteger · int32

Quantity'yi kullanıyorum.

KeywordGroup3 alanlar
idinteger · int64

Id.

namestring

Adı.

keywordsKeyword[]

Anahtar kelimeler.

KeywordAndGroup2 alanlar
keywordKeyword[]

Anahtar kelime.

groupKeywordGroup[]

Grup.

Hata sözleşmesi

Uygulama hataları nasıl iade edilir

error kodu her yerde aynıdır, kullanıcıya yönelik mesaj ise sunucu tarafından tercüme edilir. error etrafında uygulama mantığı oluşturun ve localMessage'i yalnızca görüntülemek için kullanın.

error

Entegre mantığı için sabit makine okunur kod.

localMessage

API token kullanıcısının dilinde görüntülemeye hazır mesaj.

params

Sunucu tarafından yerel mesaj şablonuna girilen değerler.

localMessage, API tokenine sahip olan kullanıcının lang alanını kullanır. Belgeleme dili ve Accept-Language başlığı değiştirmez; kullanıcıya dil yapılandırılmadığında Rusça kullanılır.

RUKullanıcı yerel ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
TRTürkçe (tr)
{
  "error": "error_brand_already_exists",
  "localMessage": "Base markası zaten mevcut",
  "params": {
    "name": "Base"
  }
}

Son noktaları

Son noktaları

GET

Gruptan Anahtar Sözcüğü Al

/api/keyword/group/{groupId}
Okuma erişimi olan işaret

GET /api/keyword/group/{groupId}. kullanarak Gruptan Anahtar kelimeyi alın

Yol parametreleri

AlanTürZorunluAçıklama
groupId integer · int64 Evet Grup kimliği.
curl --request GET 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Nesne alanları KeywordGroup
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
keywords Keyword[] Hayır Anahtar kelimeler.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

PUT

Anahtar kelime gruplarını id ile düzenle

/api/keyword/group/{groupId}
Yazma erişimli işaretleme

PUT /api/keyword/group/{groupId}. kullanarak Anahtar kelime grubu tarafından düzenle

Yol parametreleri

AlanTürZorunluAçıklama
groupId integer · int64 Evet Grup kimliği.

Sorgulama parametreleri

AlanTürZorunluAçıklama
newName string Hayır Yeni Ad.

İstekçi organ

application/json
curl --request PUT 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

Başarılı tepki

200
Nesne alanları KeywordGroup
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
keywords Keyword[] Hayır Anahtar kelimeler.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

DELETE

Anahtar kelime grubunu sil

/api/keyword/group/{groupId}
Yazma erişimli işaretleme

DELETE /api/keyword/group/{groupId}. kullanarak Anahtar Kelime Grubu sil

Yol parametreleri

AlanTürZorunluAçıklama
groupId integer · int64 Evet Grup kimliği.
curl --request DELETE 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Nesne alanları KeywordGroup
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
keywords Keyword[] Hayır Anahtar kelimeler.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

PUT

Anahtar kelime grubu ekle

/api/keyword/add
Yazma erişimli işaretleme

PUT /api/keyword/add. kullanarak Anahtar Kelime Grubu Ekle

Sorgulama parametreleri

AlanTürZorunluAçıklama
productId integer · int64 Hayır Ürün Kimliği.
productViewId integer · int64 Hayır Ürün Görünümü Kimliği.
modelId integer · int64 Hayır Model kimliği.

İstekçi organ

application/json
curl --request PUT 'https://api.selsup.ru/api/keyword/add' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Başarılı tepki

200

Cevapın bir vücudu yok.

Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

GET

Anahtar kelime grubunu bul

/api/keyword/group
Okuma erişimi olan işaret

GET /api/keyword/group. kullanarak Anahtar Kelime Grubu

curl --request GET 'https://api.selsup.ru/api/keyword/group' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Array öğesi yapısı KeywordGroup[]
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
keywords Keyword[] Hayır Anahtar kelimeler.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
[
  "string"
]
Hatalar4

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

400error_no_client
Müşteri bulunamadı veya silinmiş. Destek birimine yazın

Uygulama mantığında sabit error_no_client kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

POST

Anahtar kelime grubu oluştur

/api/keyword/group
Yazma erişimli işaretleme

POST /api/keyword/group. kullanarak Anahtar Kelime Grubu oluştur

Sorgulama parametreleri

AlanTürZorunluAçıklama
groupName string Evet Grup adı.

İstekçi organ

application/json
curl --request POST 'https://api.selsup.ru/api/keyword/group?groupName=Example' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

Başarılı tepki

200
Nesne alanları KeywordGroup
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
keywords Keyword[] Hayır Anahtar kelimeler.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

DELETE

Anahtar Kelime Gruplarını Sil

/api/keyword/group
Yazma erişimli işaretleme

DELETE /api/keyword/group. kullanarak Anahtar Kelime Gruplarını Sil

İstekçi organ

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/group' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Başarılı tepki

200
"string"
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

POST

Anahtar kelime gruplarını birleştirin

/api/keyword/group/merge
Yazma erişimli işaretleme

POST /api/keyword/group/merge. kullanarak Anahtar Kelime Gruplarını Birleştirin

Sorgulama parametreleri

AlanTürZorunluAçıklama
newGroupName string Evet Yeni Grup Adı.

İstekçi organ

application/json
curl --request POST 'https://api.selsup.ru/api/keyword/group/merge?newGroupName=Example' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Başarılı tepki

200
Nesne alanları KeywordGroup
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
keywords Keyword[] Hayır Anahtar kelimeler.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
Hatalar7

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

400error_empty_group_name
Anahtar kelime grubu adı boş olamaz

Uygulama mantığında sabit error_empty_group_name kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

400error_empty_keywords_groups
Группа ключевых слов пустая

Uygulama mantığında sabit error_empty_keywords_groups kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

400error_need_at_least_two_groups
en az iki grup gerekiyor

Uygulama mantığında sabit error_need_at_least_two_groups kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

400error_no_client
Müşteri bulunamadı veya silinmiş. Destek birimine yazın

Uygulama mantığında sabit error_no_client kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

GET

Kilit Sözcükleri Bul

/api/keyword/{modelId}
Okuma erişimi olan işaret

GET /api/keyword/{modelId}. ile Entity için Anahtar Kelime Al

Yol parametreleri

AlanTürZorunluAçıklama
modelId integer · int64 Evet Model kimliği.
curl --request GET 'https://api.selsup.ru/api/keyword/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Nesne alanları KeywordAndGroup
AlanTürZorunluAçıklama
keyword Keyword[] Hayır Anahtar kelime.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
group KeywordGroup[] Hayır Grup.
Array öğesi yapısı KeywordGroup
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
keywords Keyword[] Hayır Anahtar kelimeler.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
{
  "keyword": "string",
  "group": "string"
}
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

GET

Anahtar kelime grubunu bul

/api/keyword/group/find
Okuma erişimi olan işaret

GET /api/keyword/group/find. kullanarak Anahtar Kelime Grubu bulun

Sorgulama parametreleri

AlanTürZorunluAçıklama
word string Evet - Söz.
curl --request GET 'https://api.selsup.ru/api/keyword/group/find?word=string' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Array öğesi yapısı KeywordGroup[]
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
keywords Keyword[] Hayır Anahtar kelimeler.
Array öğesi yapısı Keyword
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
usingQuantity integer · int32 Hayır Quantity'yi kullanıyorum.
[
  "string"
]
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

DELETE

Anahtar kelime grubunu kurumdan sil

/api/keyword/model/{modelId}
Yazma erişimli işaretleme

DELETE /api/keyword/model/{modelId}. kullanarak Kilit Keyleri Grubu Entity'den Sil

Yol parametreleri

AlanTürZorunluAçıklama
modelId integer · int64 Evet Model kimliği.

İstekçi organ

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/model/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Başarılı tepki

200
"string"
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

DELETE

Gruptan Anahtar Kelime Sil

/api/keyword/group/{groupId}/keywords
Yazma erişimli işaretleme

DELETE /api/keyword/group/{groupId}/keywords. kullanarak Gruptan Anahtar kelimeyi sil

Yol parametreleri

AlanTürZorunluAçıklama
groupId integer · int64 Evet Grup kimliği.

İstekçi organ

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/group/1001/keywords' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Başarılı tepki

200
"string"
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

Authorization

Test istekleri için işaret

Token bu tarayıcı lokalStorage'da kalır ve sadece api.selsup.ru adresine Authorization başlığındaki isteklerde gönderilir.

Dene

Gerçek talep parametreleri

Canlı API tepkisi

SelSup cevabını görmek için bir istek gönderin.