Modele są wymienione tutaj raz i mogą być również rozszerzane bezpośrednio z punktów końcowych, które je wykorzystują.
Keyword3 pola
idinteger · int64
Id.
namestring
- Nazwa.
usingQuantityinteger · int32
Używając Quantity.
KeywordGroup3 pola
idinteger · int64
Id.
namestring
- Nazwa.
keywordsKeyword[]
Kluczowe słowa.
KeywordAndGroup2 pola
keywordKeyword[]
- Słowo kluczowe.
groupKeywordGroup[]
Grupa.
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ź kluczowe słowo z grupy
/api/keyword/group/{groupId}
Token z dostępem do odczytu
Uzyskaj słowo kluczowe z grupy za pomocą GET /api/keyword/group/{groupId}.
Parametry ścieżki
Pole
Typ
Wymagane
Opis
groupId
integer · int64
Tak
Id grupy.
curl --request GET 'https://api.selsup.ru/api/keyword/group/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_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.
POST
Utworzenie grupy słów kluczowych
/api/keyword/group
Token z dostępem do pisania
Utworzenie grupy słów kluczowych za pomocą POST /api/keyword/group.
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_group_name
Nazwa grupy słów kluczowych nie może być pusta
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_group_name; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
400error_empty_keywords_groups
Grupa słów kluczowych jest pusta
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_keywords_groups; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.
400error_need_at_least_two_groups
wymagane są co najmniej dwie grupy
error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_need_at_least_two_groups; 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
Znajdź kluczowe słowo dla podmiotu
/api/keyword/{modelId}
Token z dostępem do odczytu
Uzyskaj słowo kluczowe dla podmiotu za pomocą GET /api/keyword/{modelId}.
Parametry ścieżki
Pole
Typ
Wymagane
Opis
modelId
integer · int64
Tak
Identyczny model.
curl --request GET 'https://api.selsup.ru/api/keyword/1001' \
--header 'Authorization: YOUR_API_TOKEN'