SelSup Developers

Le public API · API Référence

Les concurrents

Les points de référence pour les concurrents, y compris les itinéraires exacts, les paramètres, les instances de demande et les schémas de réponse extensibles.

4 points de fin/api/competitorStableDéclaration lisible par machine ↗
{ }

Cette page est soutenue par un contrat indépendant éditable. Valider les opérations de rédaction avec des données de test avant utilisation de production.

/api/competitor

Flux de travail prêts à l'emploi

Flux de travail prêts à l'emploi

01

Commencez à utiliser les concurrents

Utilisez un jeton API dédié et validez d'abord les opérations de lecture avec les données de test.

  1. Gardez le jeton côté serveur et envoyez-le dans l'en-tête Authorization.
  2. Vérifiez les paramètres requis et élargissez le schéma de demande ou de réponse.
  3. Traiter l'état HTTP et le champ stable error dans les erreurs d'application.

Modèle de données

Structures de données

Les modèles sont énumérés une fois ici et peuvent également être étendus directement depuis les terminaux qui les utilisent.

Competitor6 champs
idinteger · int64

Id.

read-only
modelIdinteger · int64

Nom de modèle.

servicestring

Le service.

Obligatoire
urlstring

- Je vous en prie.

Obligatoire
serviceIdstring

Identification du service.

clientIdinteger · int64

Nom du client.

read-only

Contrats d'erreur

Comment les erreurs d'application sont retournées

Le code error est identique dans chaque locale, tandis que le message d'utilisateur est traduit par le serveur.

Le projet de loi

Code stable lisible par machine pour la logique d'intégration.

Le projet de loi

Message prêt à être affiché dans la langue de l'utilisateur de jeton API.

Le projet de loi

Les valeurs interpolées par le serveur dans le modèle de message localisé.

localMessage utilise le champ lang de l'utilisateur qui possède le jeton API. Le langage de documentation et l'en-tête Accept-Language ne le modifient pas; le russe est utilisé lorsque l'usager n'a pas de langue configurée.

RULocalisation de l'utilisateur est ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
FRFrançais (fr)
{
  "error": "error_brand_already_exists",
  "localMessage": "La marque Base existe déjà",
  "params": {
    "name": "Base"
  }
}

Les points de fin

Les points de fin

PUT

Mise à jour

/api/competitor/{competitorId}
Token avec accès à l'écriture

Mise à jour à l'aide de PUT /api/competitor/{competitorId}.

Parametres de parcours

ChampTypeObligatoireDescription
competitorId integer · int64 Oui Identification du concurrent.

Organisme de demande

application/json
champs d'objetCompetitor
ChampTypeObligatoireDescription
id integer · int64 Non Id.
modelId integer · int64 Non Nom de modèle.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Oui Le service.
url string Oui - Je vous en prie.
serviceId string Non Identification du service.
clientId integer · int64 Non Nom du client.
curl --request PUT 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

Réponse réussie

200

La réponse n'a pas de corps.

Les erreurs8

Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑

401auth_required
Autentification requise

Authorization est manquant, vide ou contient un jeton non valide.

400error_access_denied
Accès refusé

Le jeton existe, mais son rôle ne peut pas effectuer cette opération.

500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance

Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.

400error_competitor_id_required
Id du concurrent requis

error spécifique au point final. Utilisez le code error_competitor_id_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_competitor_required
Concurrent obligatoire

error spécifique au point final. Utilisez le code error_competitor_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_competitor_service_required
Le service concurrent est obligatoire

error spécifique au point final. Utilisez le code error_competitor_service_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_competitor_url_required
Lien du concurrent obligatoire

error spécifique au point final. Utilisez le code error_competitor_url_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_no_client
Client introuvable ou supprimé. Écrivez au support

error spécifique au point final. Utilisez le code error_no_client stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

DELETE

Supprimer

/api/competitor/{competitorId}
Token avec accès à l'écriture

Supprimer en utilisant DELETE /api/competitor/{competitorId}.

Parametres de parcours

ChampTypeObligatoireDescription
competitorId integer · int64 Oui Identification du concurrent.
curl --request DELETE 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200

La réponse n'a pas de corps.

Les erreurs5

Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑

401auth_required
Autentification requise

Authorization est manquant, vide ou contient un jeton non valide.

400error_access_denied
Accès refusé

Le jeton existe, mais son rôle ne peut pas effectuer cette opération.

500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance

Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.

400error_competitor_id_required
Id du concurrent requis

error spécifique au point final. Utilisez le code error_competitor_id_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_no_client
Client introuvable ou supprimé. Écrivez au support

error spécifique au point final. Utilisez le code error_no_client stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

GET

Prenez tout

/api/competitor/{modelId}
Token avec accès à la lecture

Obtenez tout en utilisant GET /api/competitor/{modelId}.

Parametres de parcours

ChampTypeObligatoireDescription
modelId integer · int64 Oui Nom de modèle.
curl --request GET 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200
Structure des éléments de l'array Competitor[]
ChampTypeObligatoireDescription
id integer · int64 Non Id.
modelId integer · int64 Non Nom de modèle.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Oui Le service.
url string Oui - Je vous en prie.
serviceId string Non Identification du service.
clientId integer · int64 Non Nom du client.
[
  "string"
]
Les erreurs5

Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑

401auth_required
Autentification requise

Authorization est manquant, vide ou contient un jeton non valide.

400error_access_denied
Accès refusé

Le jeton existe, mais son rôle ne peut pas effectuer cette opération.

500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance

Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.

400error_model_id_required
ID de modèle requis

error spécifique au point final. Utilisez le code error_model_id_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_no_client
Client introuvable ou supprimé. Écrivez au support

error spécifique au point final. Utilisez le code error_no_client stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

POST

Créer

/api/competitor/{modelId}
Token avec accès à l'écriture

Créer à l'aide de POST /api/competitor/{modelId}.

Parametres de parcours

ChampTypeObligatoireDescription
modelId integer · int64 Oui Nom de modèle.

Organisme de demande

application/json
champs d'objetCompetitor
ChampTypeObligatoireDescription
id integer · int64 Non Id.
modelId integer · int64 Non Nom de modèle.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Oui Le service.
url string Oui - Je vous en prie.
serviceId string Non Identification du service.
clientId integer · int64 Non Nom du client.
curl --request POST 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

Réponse réussie

200
champs d'objet Competitor
ChampTypeObligatoireDescription
id integer · int64 Non Id.
modelId integer · int64 Non Nom de modèle.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Oui Le service.
url string Oui - Je vous en prie.
serviceId string Non Identification du service.
clientId integer · int64 Non Nom du client.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
Les erreurs7

Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑

401auth_required
Autentification requise

Authorization est manquant, vide ou contient un jeton non valide.

400error_access_denied
Accès refusé

Le jeton existe, mais son rôle ne peut pas effectuer cette opération.

500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance

Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.

400error_competitor_required
Concurrent obligatoire

error spécifique au point final. Utilisez le code error_competitor_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_competitor_service_required
Le service concurrent est obligatoire

error spécifique au point final. Utilisez le code error_competitor_service_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_competitor_url_required
Lien du concurrent obligatoire

error spécifique au point final. Utilisez le code error_competitor_url_required stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

400error_no_client
Client introuvable ou supprimé. Écrivez au support

error spécifique au point final. Utilisez le code error_no_client stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.

Authorization

Marque pour les demandes d'essai

Le jeton reste dans le localStorage de ce navigateur et est envoyé uniquement dans l'en-tête Authorization des demandes à api.selsup.ru.

Essayer

Parametres réels de la demande

Réponse en direct API

Envoyez une demande pour voir la réponse SelSup.