SelSup Developers

Halk API · API İpucu

Ayarlar

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

3 Son noktaları/api/propertyDayanıklıMakine okuyabilir açıklama ↗
{ }

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

/api/property

Kullanılabilir iş akışları

Kullanılabilir iş akışları

01

Ayarları kullanmaya başlayın

Özel bir API token kullanın ve önce test verileri ile okuma işlemlerini doğrulayın.

  1. Token sunucu tarafında tut ve Authorization başlığı gönder.
  2. Gerekli parametreleri kontrol edin ve istek veya yanıt şeması genişletin.
  3. Uygulama hatalarında HTTP durumunu ve sabit error alanını ele alın.

Verim modeli

Veriler yapısı

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

Property6 alanlar
organizationIdinteger · int64

Teşkilat Kimliği.

clientIdinteger · int64

Müşteri kimliği.

read-only
componentstring

- Komponent.

namestring

Adı.

valuestring

Değer.

valueNamestring

Değer Adı.

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ı

PUT

Mülkiyetinizi Verin

/api/property/
Yazma erişimli işaretleme

PUT /api/property/. kullanarak Mülkiyet koy

İstekçi organ

application/json
Nesne alanlarıProperty
AlanTürZorunluAçıklama
organizationId integer · int64 Hayır Teşkilat Kimliği.
clientId integer · int64 Hayır Müşteri kimliği.
component string Hayır - Komponent.
name string Hayır Adı.
value string Hayır Değer.
valueName string Hayır Değer Adı.
curl --request PUT 'https://api.selsup.ru/api/property/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}'

Başarılı tepki

200

Cevapın bir vücudu yok.

Hatalar5

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_invalid_currency_source
Belirtilen döviz kuru kaynağı desteklenmiyor

Uygulama mantığında sabit error_invalid_currency_source 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

Al bakalım.

/api/property/{organizationId}/{component}
Okuma erişimi olan işaret

GET /api/property/{organizationId}/{component}. kullanın

Yol parametreleri

AlanTürZorunluAçıklama
organizationId integer · int64 Evet Teşkilat Kimliği.
component string Evet - Komponent.
curl --request GET 'https://api.selsup.ru/api/property/1001/string' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
"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_header_logo_upload_failed
Could not upload the logo. Please try again.

Uygulama mantığında sabit error_header_logo_upload_failed 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.

400error_ozon_fbo_workflow_not_found
Ozon FBO iş akışı {id} bulunamadı

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

400error_user_does_not_have_this_organization
У пользователя нет доступа к данной организации

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

GET

Liste

/api/property/list/{component}
Okuma erişimi olan işaret

GET /api/property/list/{component}. kullanan liste

Yol parametreleri

AlanTürZorunluAçıklama
component string Evet - Komponent.

Sorgulama parametreleri

AlanTürZorunluAçıklama
organizationId integer · int64 Hayır Teşkilat Kimliği.
curl --request GET 'https://api.selsup.ru/api/property/list/string' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Array öğesi yapısı Property[]
AlanTürZorunluAçıklama
organizationId integer · int64 Hayır Teşkilat Kimliği.
clientId integer · int64 Hayır Müşteri kimliği.
component string Hayır - Komponent.
name string Hayır Adı.
value string Hayır Değer.
valueName string Hayır Değer Adı.
[
  "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_subscription_expired
Tarife süreniz doldu. Hizmeti kullanmaya devam etmek için tarifeyi ödeyin.

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

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.