SelSup Developers

Public API · API Referencja

Wykonawcy

Punkty końcowe dla producentów, w tym dokładne trasy, parametry, organy żądania i rozszerzalne schematy odpowiedzi.

5 punkty końcowe/api/manufacturerStabilnyOpis czytelny maszynowo ↗
{ }

Strona ta jest wspierana przez edytowalny samodzielny kontrakt.

/api/manufacturer

Gotowe do użytkowania przepływy robocze

Gotowe do użytkowania przepływy robocze

01

Zacznij używać Producenci

Użyj dedykowanego tokena API i najpierw sprawdź operacje odczytu z danymi testowymi.

  1. Trzymaj token z serwera i wysłać go w nagłówku Authorization.
  2. Sprawdź wymagane parametry i poszerz schemat żądania lub odpowiedzi.
  3. Zrób z statusem HTTP i stabilnym pole error w przypadku błędów aplikacyjnych.

Model danych

Struktura danych

Modele są wymienione tutaj raz i mogą być również rozszerzane bezpośrednio z punktów końcowych, które je wykorzystują.

Manufacturer11 pola
manufacturerIdinteger · int32

Idekcja producenta.

titlestring

Tytuł.

namestring

- Nazwa.

Wymagane
addressstring

- Adres.

organizationIdinteger · int64

Id organizacyjny.

clientIdinteger · int64

Id klientów.

read-only
countryIdinteger · int32

Id państwowy.

countryNamestring

Nazwa kraju.

read-only
innstring

- W hostażu.

deletedboolean

- Zlikwidowane.

oneCIdstring

Jeden CID.

FindResponseManufacturer1 pola
rowsManufacturer[]

Rzędy.

Umowa o błędzie

W jaki sposób można zwrócić błędy w aplikacji

Kod error jest identyczny w każdym miejscu, podczas gdy wiadomość skierowana do użytkownika jest tłumaczona przez serwer.

error

Stabilny kod czytelny maszynowo do logiki integracyjnej.

localMessage

Przesłanie gotowe do wyświetlania w języku użytkownika tokenu API.

params

Wartości interpołowane przez serwer w szablonie lokalizowanej wiadomości.

localMessage wykorzystuje pole lang użytkownika, który posiada token API. Język dokumentacji i nagłówek Accept-Language nie zmieniają go; rosyjski jest używany, gdy użytkujący nie ma konfigurowanego języka.

RULokalizacja użytkownika jest ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
PLPolski (pl)
{
  "error": "error_brand_already_exists",
  "localMessage": "Marka Base już istnieje",
  "params": {
    "name": "Base"
  }
}

Punkty końcowe

Punkty końcowe

GET

Znajdź producenta według identyfikatu

/api/manufacturer/{manufacturerId}
Token z dostępem do odczytu

Uzyskaj identyfikację producenta za pomocą GET /api/manufacturer/{manufacturerId}.

Parametry ścieżki

PoleTypWymaganeOpis
manufacturerId integer · int32 Tak Idekcja producenta.
curl --request GET 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu Manufacturer
PoleTypWymaganeOpis
manufacturerId integer · int32 Nie Idekcja producenta.
title string Nie Tytuł.
name string Tak - Nazwa.
address string Nie - Adres.
organizationId integer · int64 Nie Id organizacyjny.
clientId integer · int64 Nie Id klientów.
countryId integer · int32 Nie Id państwowy.
countryName string Nie Nazwa kraju.
inn string Nie - W hostażu.
deleted boolean Nie - Zlikwidowane.
oneCId string Nie Jeden CID.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Władze6

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_manufacturer_not_found
Nie znaleziono producenta: {id}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_manufacturer_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_subscription_expired
Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

PUT

Aktualizacja Producent

/api/manufacturer/{manufacturerId}
Token z dostępem do pisania

Aktualizacja Producent używający PUT /api/manufacturer/{manufacturerId}.

Parametry ścieżki

PoleTypWymaganeOpis
manufacturerId integer · int64 Tak Idekcja producenta.

Organ wnioskujący

application/json
Połączenia obiektuManufacturer
PoleTypWymaganeOpis
manufacturerId integer · int32 Nie Idekcja producenta.
title string Nie Tytuł.
name string Tak - Nazwa.
address string Nie - Adres.
organizationId integer · int64 Nie Id organizacyjny.
clientId integer · int64 Nie Id klientów.
countryId integer · int32 Nie Id państwowy.
countryName string Nie Nazwa kraju.
inn string Nie - W hostażu.
deleted boolean Nie - Zlikwidowane.
oneCId string Nie Jeden CID.
curl --request PUT 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

Odpowiedź udana

200
Połączenia obiektu Manufacturer
PoleTypWymaganeOpis
manufacturerId integer · int32 Nie Idekcja producenta.
title string Nie Tytuł.
name string Tak - Nazwa.
address string Nie - Adres.
organizationId integer · int64 Nie Id organizacyjny.
clientId integer · int64 Nie Id klientów.
countryId integer · int32 Nie Id państwowy.
countryName string Nie Nazwa kraju.
inn string Nie - W hostażu.
deleted boolean Nie - Zlikwidowane.
oneCId string Nie Jeden CID.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Władze7

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_empty_manufacturer_name
Nie podano nazwy producenta

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_manufacturer_name; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_manufacturer_already_exist
Producent o nazwie {name} już istnieje

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_manufacturer_already_exist; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_subscription_expired
Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

DELETE

Wykrycie

/api/manufacturer/{manufacturerId}
Token z dostępem do pisania

Wyjmowanie Producent używając DELETE /api/manufacturer/{manufacturerId}.

Parametry ścieżki

PoleTypWymaganeOpis
manufacturerId integer · int32 Tak Idekcja producenta.

Parametry zapytania

PoleTypWymaganeOpis
deleted boolean Tak - Zlikwidowane.
curl --request DELETE 'https://api.selsup.ru/api/manufacturer/1001?deleted=false' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
"string"
Władze3

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

POST

Tworzenie Producenta

/api/manufacturer
Token z dostępem do pisania

Utworzenie Producenta za pomocą POST /api/manufacturer.

Organ wnioskujący

application/json
Połączenia obiektuManufacturer
PoleTypWymaganeOpis
manufacturerId integer · int32 Nie Idekcja producenta.
title string Nie Tytuł.
name string Tak - Nazwa.
address string Nie - Adres.
organizationId integer · int64 Nie Id organizacyjny.
clientId integer · int64 Nie Id klientów.
countryId integer · int32 Nie Id państwowy.
countryName string Nie Nazwa kraju.
inn string Nie - W hostażu.
deleted boolean Nie - Zlikwidowane.
oneCId string Nie Jeden CID.
curl --request POST 'https://api.selsup.ru/api/manufacturer' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

Odpowiedź udana

200
Połączenia obiektu Manufacturer
PoleTypWymaganeOpis
manufacturerId integer · int32 Nie Idekcja producenta.
title string Nie Tytuł.
name string Tak - Nazwa.
address string Nie - Adres.
organizationId integer · int64 Nie Id organizacyjny.
clientId integer · int64 Nie Id klientów.
countryId integer · int32 Nie Id państwowy.
countryName string Nie Nazwa kraju.
inn string Nie - W hostażu.
deleted boolean Nie - Zlikwidowane.
oneCId string Nie Jeden CID.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Władze7

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_empty_manufacturer_name
Nie podano nazwy producenta

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_manufacturer_name; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_manufacturer_already_exist
Producent o nazwie {name} już istnieje

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_manufacturer_already_exist; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_subscription_expired
Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

GET

Znajdź

/api/manufacturer/find
Token z dostępem do odczytu

Znajdź używając GET /api/manufacturer/find.

Parametry zapytania

PoleTypWymaganeOpis
query string Nie - Nie wiem.
manufacturerOneCId string Nie Producent 1 CId.
limit integer · int32 Nie Ogranicz.
page integer · int32 Nie Strona.
count boolean Nie Zgromadzisz.
sortBy stringMANUFACTURERID, NAME Nie - Zarejestrowany.
ascending boolean Nie Wzniesienie.
curl --request GET 'https://api.selsup.ru/api/manufacturer/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu FindResponseManufacturer
PoleTypWymaganeOpis
rows Manufacturer[] Nie Rzędy.
Struktura pozycji zestawu Manufacturer
PoleTypWymaganeOpis
manufacturerId integer · int32 Nie Idekcja producenta.
title string Nie Tytuł.
name string Tak - Nazwa.
address string Nie - Adres.
organizationId integer · int64 Nie Id organizacyjny.
clientId integer · int64 Nie Id klientów.
countryId integer · int32 Nie Id państwowy.
countryName string Nie Nazwa kraju.
inn string Nie - W hostażu.
deleted boolean Nie - Zlikwidowane.
oneCId string Nie Jeden CID.
{
  "rows": "string"
}
Władze5

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_subscription_expired
Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

Authorization

Token do wniosków o badania

Token pozostaje w lokalnym magazynie przeglądarki i jest wysyłany tylko w nagłówku Authorization z wniosków na api.selsup.ru.

Wypróbuj

Prawdziwe parametry żądania

Odpowiedź API

Wyślij wniosek o zapoznanie się z odpowiedzią SelSup.