Ushbu sahifani tahrirlash mumkin bo'lgan mustaqil shartnoma bilan ta'minlaydi. Ishlab chiqarishdan oldin sinov ma'lumotlari bilan yozish operatsiyalarini tasdiqlash.
/api/keyword
Ishga tayyor ish oqimlari
Ishga tayyor ish oqimlari
01
& amp; Boshqacha soʻzlarni ishlatishni boshlang
API tokenidan foydalaning va avval o'qish operatsiyalarini sinov ma'lumotlari bilan tasdiqlash.
Tokeni server tomoniga saqlang va Authorization boshliqida yuboring.
Kerakli parametrlarni tekshiring va so'rov yoki javob sxemasini kengaytiring.
HTTP holatini va error o'rniga dastur xatolarida ishlash.
Modellari bu yerda bir marta ro'yxatga olingan va ularni ishlatadigan oxirgi nuqtalardan to'g'ridan-to'gʻri kengaytirilishi mumkin.
Keyword3 maydonlar
idinteger · int64
Id.
namestring
Ism.
usingQuantityinteger · int32
Ko'plikdan foydalaning.
KeywordGroup3 maydonlar
idinteger · int64
Id.
namestring
Ism.
keywordsKeyword[]
Keywordlar.
KeywordAndGroup2 maydonlar
keywordKeyword[]
Muhim so'z.
groupKeywordGroup[]
Guruh.
Xato shartnomasi
Ilovalar xatolarini qaytarib berish usuli
error kodlari har bir joyda bir xil, foydalanuvchiga qaratilgan xabar server tomonidan tarjima qilinadi. error atrofida dastur mantiqasini quring va localMessage-dan faqat ko'rsatish uchun foydalaning.
error
Integratsiya mantiqasini yaratish uchun barqaror mashina o'qiladigan kod.
localMessage
API token foydalanuvchisining tilida ko'rsatishga tayyor xabar.
params
Server tomonidan mahalliylashtirilgan xabar namunalariga interpolatsiya qilingan qiymatlar.
文
localMessage API tokenini egallagan foydalanuvchining lang maydoni ishlatiladi. Hujjat tili va Accept-Language boshliq uni o'zgartirmaydi; foydalanuvchi tilni moslamasa rus tilida ishlatiladigan.
RUFoydalanuvchi manzili ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
PUT
Keyword guruhini ID boʻyicha tahrirlash
/api/keyword/group/{groupId}
Yozib olish imkoniyatiga ega token
PUT /api/keyword/group/{groupId}. yordamida kalit soʻz guruhini ID boʻyicha tahrirlash
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
DELETE
Asosiy soʻzlar guruhi
/api/keyword/group/{groupId}
Yozib olish imkoniyatiga ega token
DELETE /api/keyword/group/{groupId}. yordamida kalit soʻzlar guruhi oʻchirish
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
PUT
Asosiy soʻz guruhi qoʻshish
/api/keyword/add
Yozib olish imkoniyatiga ega token
PUT /api/keyword/add. yordamida kalit soʻz guruhi qoʻshish
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
GET
Asosiy soʻz guruhini oling
/api/keyword/group
Oʻqish imkoniyatiga ega token
GET /api/keyword/group. yordamida kalit soʻzlar guruhi
curl --request GET 'https://api.selsup.ru/api/keyword/group' \
--header 'Authorization: YOUR_API_TOKEN'
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
400error_no_client
Mijoz topilmadi yoki o'chirilgan. Qo'llab-quvvatlash xizmatiga yozing
Uchrashuvda error-dan foydalanish. error_no_client kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.
POST
Asosiy soʻzlar guruhi yaratish
/api/keyword/group
Yozib olish imkoniyatiga ega token
POST /api/keyword/group. yordamida kalit soʻz guruhi yaratish
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
DELETE
Asosiy soʻz guruhlarini oʻchirish
/api/keyword/group
Yozib olish imkoniyatiga ega token
DELETE /api/keyword/group. yordamida kalit soʻz guruhlarini oʻchirish
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
POST
Asosiy soʻz guruhlarini birlashtirish
/api/keyword/group/merge
Yozib olish imkoniyatiga ega token
POST /api/keyword/group/merge. yordamida kalit soʻz guruhlarini birlashtirish
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
400error_empty_group_name
Kalit so'zlar guruhi nomi bo'sh bo'lishi mumkin emas
Uchrashuvda error-dan foydalanish. error_empty_group_name kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.
400error_empty_keywords_groups
Kalit so‘zlar guruhi bo‘sh
Uchrashuvda error-dan foydalanish. error_empty_keywords_groups kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.
400error_need_at_least_two_groups
Kamida ikkita guruh kerak
Uchrashuvda error-dan foydalanish. error_need_at_least_two_groups kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.
400error_no_client
Mijoz topilmadi yoki o'chirilgan. Qo'llab-quvvatlash xizmatiga yozing
Uchrashuvda error-dan foydalanish. error_no_client kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.
GET
Entitet uchun kalit soʻzni toping
/api/keyword/{modelId}
Oʻqish imkoniyatiga ega token
GET /api/keyword/{modelId}. yordamida Entity uchun kalit soʻzni olish
Yo'l parametrlari
Maydon
Tur
Majburiy
Tavsif
modelId
integer · int64
Ha
Model ID.
curl --request GET 'https://api.selsup.ru/api/keyword/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
GET
Asosiy soʻzlar guruhini toping
/api/keyword/group/find
Oʻqish imkoniyatiga ega token
GET /api/keyword/group/find. yordamida kalit soʻz guruhi toping
Soʻrov parametrlari
Maydon
Tur
Majburiy
Tavsif
word
string
Ha
So'z.
curl --request GET 'https://api.selsup.ru/api/keyword/group/find?word=string' \
--header 'Authorization: YOUR_API_TOKEN'
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
DELETE
Asosiy soʻz guruhi
/api/keyword/model/{modelId}
Yozib olish imkoniyatiga ega token
DELETE /api/keyword/model/{modelId}. yordamida Entity-dan kalit soʻz guruhi oʻchirish
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.
DELETE
Guruhdan kalit soʻzni oʻchirish
/api/keyword/group/{groupId}/keywords
Yozib olish imkoniyatiga ega token
DELETE /api/keyword/group/{groupId}/keywords. yordamida guruhdan kalit soʻzni oʻchirish
Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑
401auth_required
Tasdiqlash talab etiladi
Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.
400error_access_denied
Kirish taqiqlangan
Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.
500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing
Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.