SelSup Developers

Public API · API Referencja

Kluczowe słowa

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

12 punkty końcowe/api/keywordStabilnyOpis czytelny maszynowo ↗
{ }

Strona ta jest wspierana przez edytowalny samodzielny kontrakt.

/api/keyword

Gotowe do użytkowania przepływy robocze

Gotowe do użytkowania przepływy robocze

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

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

PoleTypWymaganeOpis
groupId integer · int64 Tak Id grupy.
curl --request GET 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu KeywordGroup
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
keywords Keyword[] Nie Kluczowe słowa.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
{
  "id": 1001,
  "name": "Example",
  "keywords": "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.

PUT

Edytorz grupę słów kluczowych według id

/api/keyword/group/{groupId}
Token z dostępem do pisania

Edytorz grupę słów kluczowych według id za pomocą PUT /api/keyword/group/{groupId}.

Parametry ścieżki

PoleTypWymaganeOpis
groupId integer · int64 Tak Id grupy.

Parametry zapytania

PoleTypWymaganeOpis
newName string Nie Nowy Nazwa.

Organ wnioskujący

application/json
curl --request PUT 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

Odpowiedź udana

200
Połączenia obiektu KeywordGroup
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
keywords Keyword[] Nie Kluczowe słowa.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
{
  "id": 1001,
  "name": "Example",
  "keywords": "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.

DELETE

Usunięcie grupy słów kluczowych

/api/keyword/group/{groupId}
Token z dostępem do pisania

Usuwanie grupy słów kluczowych za pomocą DELETE /api/keyword/group/{groupId}.

Parametry ścieżki

PoleTypWymaganeOpis
groupId integer · int64 Tak Id grupy.
curl --request DELETE 'https://api.selsup.ru/api/keyword/group/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu KeywordGroup
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
keywords Keyword[] Nie Kluczowe słowa.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
{
  "id": 1001,
  "name": "Example",
  "keywords": "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.

PUT

Dodaj grupę słów kluczowych

/api/keyword/add
Token z dostępem do pisania

Dodaj grupę słów kluczowych za pomocą PUT /api/keyword/add.

Parametry zapytania

PoleTypWymaganeOpis
productId integer · int64 Nie Id produktu.
productViewId integer · int64 Nie Id widoku produktu.
modelId integer · int64 Nie Identyczny model.

Organ wnioskujący

application/json
curl --request PUT 'https://api.selsup.ru/api/keyword/add' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Odpowiedź udana

200

Odpowiedź nie ma ciała.

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.

GET

Zdobądź grupę słów kluczowych

/api/keyword/group
Token z dostępem do odczytu

Uzyskaj grupę słów kluczowych za pomocą GET /api/keyword/group.

curl --request GET 'https://api.selsup.ru/api/keyword/group' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Struktura pozycji zestawu KeywordGroup[]
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
keywords Keyword[] Nie Kluczowe słowa.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
[
  "string"
]
Władze4

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.

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.

Parametry zapytania

PoleTypWymaganeOpis
groupName string Tak Nazwa grupy.

Organ wnioskujący

application/json
curl --request POST 'https://api.selsup.ru/api/keyword/group?groupName=Example' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

Odpowiedź udana

200
Połączenia obiektu KeywordGroup
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
keywords Keyword[] Nie Kluczowe słowa.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
{
  "id": 1001,
  "name": "Example",
  "keywords": "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.

DELETE

Usunięcie grup słów kluczowych

/api/keyword/group
Token z dostępem do pisania

Usuwanie grup słów kluczowych za pomocą DELETE /api/keyword/group.

Organ wnioskujący

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/group' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

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

Złączyć grupy słów kluczowych

/api/keyword/group/merge
Token z dostępem do pisania

Połączenie grup słów kluczowych za pomocą POST /api/keyword/group/merge.

Parametry zapytania

PoleTypWymaganeOpis
newGroupName string Tak Nowa nazwa grupy.

Organ wnioskujący

application/json
curl --request POST 'https://api.selsup.ru/api/keyword/group/merge?newGroupName=Example' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

Odpowiedź udana

200
Połączenia obiektu KeywordGroup
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
keywords Keyword[] Nie Kluczowe słowa.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
{
  "id": 1001,
  "name": "Example",
  "keywords": "string"
}
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_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

PoleTypWymaganeOpis
modelId integer · int64 Tak Identyczny model.
curl --request GET 'https://api.selsup.ru/api/keyword/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu KeywordAndGroup
PoleTypWymaganeOpis
keyword Keyword[] Nie - Słowo kluczowe.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
group KeywordGroup[] Nie Grupa.
Struktura pozycji zestawu KeywordGroup
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
keywords Keyword[] Nie Kluczowe słowa.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
{
  "keyword": "string",
  "group": "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.

GET

Znajdź grupę słów kluczowych

/api/keyword/group/find
Token z dostępem do odczytu

Znajdź grupę słów kluczowych za pomocą GET /api/keyword/group/find.

Parametry zapytania

PoleTypWymaganeOpis
word string Tak - Słowo.
curl --request GET 'https://api.selsup.ru/api/keyword/group/find?word=string' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Struktura pozycji zestawu KeywordGroup[]
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
keywords Keyword[] Nie Kluczowe słowa.
Struktura pozycji zestawu Keyword
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
usingQuantity integer · int32 Nie Używając Quantity.
[
  "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.

DELETE

Usuwanie grupy słów kluczowych z podmiotu

/api/keyword/model/{modelId}
Token z dostępem do pisania

Usuwanie grupy słów kluczowych z podmiotu za pomocą DELETE /api/keyword/model/{modelId}.

Parametry ścieżki

PoleTypWymaganeOpis
modelId integer · int64 Tak Identyczny model.

Organ wnioskujący

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/model/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

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.

DELETE

Usunięcie słowa kluczowego z grupy

/api/keyword/group/{groupId}/keywords
Token z dostępem do pisania

Usuwanie słowa kluczowe z grupy za pomocą DELETE /api/keyword/group/{groupId}/keywords.

Parametry ścieżki

PoleTypWymaganeOpis
groupId integer · int64 Tak Id grupy.

Organ wnioskujący

application/json
curl --request DELETE 'https://api.selsup.ru/api/keyword/group/1001/keywords' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  1
]'

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.

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.