Modele są wymienione tutaj raz i mogą być również rozszerzane bezpośrednio z punktów końcowych, które je wykorzystują.
Competitor6 pola
idinteger · int64
Id.
read-only
modelIdinteger · int64
Identyczny model.
servicestring
- W służbie.
Wymagane
urlstring
- Url.
Wymagane
serviceIdstring
Id służbowy.
clientIdinteger · int64
Id klientów.
read-only
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
Aktualizacja
/api/competitor/{competitorId}
Token z dostępem do pisania
Aktualizacja za pomocą PUT /api/competitor/{competitorId}.
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_competitor_id_required
Wymagany jest id konkurenta
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_id_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
400error_competitor_required
Konkurent jest wymagany
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
400error_competitor_service_required
Serwis konkurenta jest obowiązkowy
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_service_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
400error_competitor_url_required
Link konkurenta jest wymagany
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_url_required; 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.
DELETE
Usuń
/api/competitor/{competitorId}
Token z dostępem do pisania
Usuwanie za pomocą DELETE /api/competitor/{competitorId}.
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_competitor_id_required
Wymagany jest id konkurenta
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_id_required; 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.
GET
/Wszystko zbierz.
/api/competitor/{modelId}
Token z dostępem do odczytu
Uzyskaj wszystkie za pomocą GET /api/competitor/{modelId}.
Parametry ścieżki
Pole
Typ
Wymagane
Opis
modelId
integer · int64
Tak
Identyczny model.
curl --request GET 'https://api.selsup.ru/api/competitor/1001' \
--header 'Authorization: YOUR_API_TOKEN'
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_model_id_required
Wymagane id modelu
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_model_id_required; 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 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_competitor_required
Konkurent jest wymagany
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
400error_competitor_service_required
Serwis konkurenta jest obowiązkowy
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_service_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
400error_competitor_url_required
Link konkurenta jest wymagany
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_url_required; 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.