SelSup Developers

Public API · API Referencja

Praca

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

3 punkty końcowe/api/jobStabilnyOpis czytelny maszynowo ↗
{ }

Strona ta jest wspierana przez edytowalny samodzielny kontrakt.

/api/job

Gotowe do użytkowania przepływy robocze

Gotowe do użytkowania przepływy robocze

01

Zacznij używać Job

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ą.

Job11 pola
idinteger · int32

Id.

namestring

- Nazwa.

categoryClassstring

Klasy kategorii.

clientIdinteger · int64

Id klientów.

deletedboolean

- Zlikwidowane.

positionIdinteger · int64

Id pozycji.

versionIdinteger · int64

Id wersji.

createdUserstring

Tworzony Użytkownik.

createdDatestring · date-time

Tworzony Termin.

pricenumber · double

- Cena.

tariffsJobTariff[]

- Ceny.

JobTariff8 pola
idinteger · int64

Id.

jobIdinteger · int32

Identyfikacja pracy.

pricenumber · double

- Cena.

brandIdinteger · int32

- Idem marka.

categoryClassstring

Klasy kategorii.

categoryIdinteger · int32

Kategoria ID.

priorityinteger · int32

Priorytet.

productIdinteger · int64

Id produktu.

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

PUT

Złóż pracę

/api/job/{jobId}
Token z dostępem do pisania

Wstawić Job za pomocą PUT /api/job/{jobId}.

Parametry ścieżki

PoleTypWymaganeOpis
jobId integer · int64 Tak Identyfikacja pracy.

Organ wnioskujący

application/json
Połączenia obiektuJob
PoleTypWymaganeOpis
id integer · int32 Nie Id.
name string Nie - Nazwa.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Nie Klasy kategorii.
clientId integer · int64 Nie Id klientów.
deleted boolean Nie - Zlikwidowane.
positionId integer · int64 Nie Id pozycji.
versionId integer · int64 Nie Id wersji.
createdUser string Nie Tworzony Użytkownik.
createdDate string · date-time Nie Tworzony Termin.
price number · double Nie - Cena.
tariffs JobTariff[] Nie - Ceny.
Struktura pozycji zestawu JobTariff
PoleTypWymaganeOpis
id integer · int64 Nie Id.
jobId integer · int32 Nie Identyfikacja pracy.
price number · double Nie - Cena.
brandId integer · int32 Nie - Idem marka.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Nie Klasy kategorii.
categoryId integer · int32 Nie Kategoria ID.
priority integer · int32 Nie Priorytet.
productId integer · int64 Nie Id produktu.
curl --request PUT 'https://api.selsup.ru/api/job/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}'

Odpowiedź udana

200
Połączenia obiektu Job
PoleTypWymaganeOpis
id integer · int32 Nie Id.
name string Nie - Nazwa.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Nie Klasy kategorii.
clientId integer · int64 Nie Id klientów.
deleted boolean Nie - Zlikwidowane.
positionId integer · int64 Nie Id pozycji.
versionId integer · int64 Nie Id wersji.
createdUser string Nie Tworzony Użytkownik.
createdDate string · date-time Nie Tworzony Termin.
price number · double Nie - Cena.
tariffs JobTariff[] Nie - Ceny.
Struktura pozycji zestawu JobTariff
PoleTypWymaganeOpis
id integer · int64 Nie Id.
jobId integer · int32 Nie Identyfikacja pracy.
price number · double Nie - Cena.
brandId integer · int32 Nie - Idem marka.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Nie Klasy kategorii.
categoryId integer · int32 Nie Kategoria ID.
priority integer · int32 Nie Priorytet.
productId integer · int64 Nie Id produktu.
{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}
Władze14

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_category_class
Nie określono klasy

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

400error_empty_job_price
Nie określono ceny za wykonanie pracy

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

400error_empty_position
Nie podano stanowiska

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

400error_empty_tariff_price
Nie podano ceny dla taryfy nr {position}

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

400error_empty_tariff_priority
Nie określono priorytetu dla taryfy

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

400error_empty_tariffs
Nie określono taryf

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

400error_job_already_exists
Zadanie o nazwie {jobName} już istnieje

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

400error_job_modified
Dane o pracy zostały już zaktualizowane. Odśwież stronę.

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

400error_job_tariff_wrong_product_id
Niepoprawnie podano identyfikator produktu: {id}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_job_tariff_wrong_product_id; 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

Zdejmij Job

/api/job/{jobId}
Token z dostępem do pisania

Usunięcie pracy za pomocą DELETE /api/job/{jobId}.

Parametry ścieżki

PoleTypWymaganeOpis
jobId integer · int32 Tak Identyfikacja pracy.

Parametry zapytania

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

Odpowiedź udana

200
"string"
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_job_modified
Dane o pracy zostały już zaktualizowane. Odśwież stronę.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_job_modified; 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.

POST

Post Job

/api/job/
Token z dostępem do pisania

Wyślij pracę za pomocą POST /api/job/.

Organ wnioskujący

application/json
Połączenia obiektuJob
PoleTypWymaganeOpis
id integer · int32 Nie Id.
name string Nie - Nazwa.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Nie Klasy kategorii.
clientId integer · int64 Nie Id klientów.
deleted boolean Nie - Zlikwidowane.
positionId integer · int64 Nie Id pozycji.
versionId integer · int64 Nie Id wersji.
createdUser string Nie Tworzony Użytkownik.
createdDate string · date-time Nie Tworzony Termin.
price number · double Nie - Cena.
tariffs JobTariff[] Nie - Ceny.
Struktura pozycji zestawu JobTariff
PoleTypWymaganeOpis
id integer · int64 Nie Id.
jobId integer · int32 Nie Identyfikacja pracy.
price number · double Nie - Cena.
brandId integer · int32 Nie - Idem marka.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Nie Klasy kategorii.
categoryId integer · int32 Nie Kategoria ID.
priority integer · int32 Nie Priorytet.
productId integer · int64 Nie Id produktu.
curl --request POST 'https://api.selsup.ru/api/job/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}'

Odpowiedź udana

200
Połączenia obiektu Job
PoleTypWymaganeOpis
id integer · int32 Nie Id.
name string Nie - Nazwa.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Nie Klasy kategorii.
clientId integer · int64 Nie Id klientów.
deleted boolean Nie - Zlikwidowane.
positionId integer · int64 Nie Id pozycji.
versionId integer · int64 Nie Id wersji.
createdUser string Nie Tworzony Użytkownik.
createdDate string · date-time Nie Tworzony Termin.
price number · double Nie - Cena.
tariffs JobTariff[] Nie - Ceny.
Struktura pozycji zestawu JobTariff
PoleTypWymaganeOpis
id integer · int64 Nie Id.
jobId integer · int32 Nie Identyfikacja pracy.
price number · double Nie - Cena.
brandId integer · int32 Nie - Idem marka.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Nie Klasy kategorii.
categoryId integer · int32 Nie Kategoria ID.
priority integer · int32 Nie Priorytet.
productId integer · int64 Nie Id produktu.
{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}
Władze12

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_category_class
Nie określono klasy

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

400error_empty_job_price
Nie określono ceny za wykonanie pracy

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

400error_empty_position
Nie podano stanowiska

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

400error_empty_tariff_price
Nie podano ceny dla taryfy nr {position}

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

400error_empty_tariff_priority
Nie określono priorytetu dla taryfy

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

400error_empty_tariffs
Nie określono taryf

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

400error_job_already_exists
Zadanie o nazwie {jobName} już istnieje

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

400error_job_tariff_wrong_product_id
Niepoprawnie podano identyfikator produktu: {id}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_job_tariff_wrong_product_id; 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.

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.