SelSup Developers

Le public API · API Référence

Étiquettes de produits

Les points d'expiration des balises de produit, y compris les itinéraires exacts, les paramètres, les corps de demande et les schémas de réponse extensibles.

9 points de fin/api/tagStableDé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/tag

Flux de travail prêts à l'emploi

Flux de travail prêts à l'emploi

01

Commencez à utiliser les balises Produits

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.

ProductTag3 champs
idinteger · int64

Id.

read-only
namestring

Nom.

Obligatoire
clientIdinteger · int64

Nom du client.

read-only
FindResponseProductTag1 champs
rowsProductTag[]

Les rangées.

FindResponseProductTagInfo1 champs
rowsProductTagInfo[]

Les rangées.

ProductTagInfo2 champs
productIdinteger · int64

Identification du produit.

productTagsProductTag[]

Étiquettes de produit.

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

Étiquette de mise à jour

/api/tag/{tagId}
Token avec accès à l'écriture

Mise à jour de l' étiquette à l'aide de PUT /api/tag/{tagId}.

Parametres de parcours

ChampTypeObligatoireDescription
tagId integer · int64 Oui - Je vous ai identifié.

Organisme de demande

application/json
champs d'objetProductTag
ChampTypeObligatoireDescription
id integer · int64 Non Id.
name string Oui Nom.
clientId integer · int64 Non Nom du client.
curl --request PUT 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

Réponse réussie

200
champs d'objet ProductTag
ChampTypeObligatoireDescription
id integer · int64 Non Id.
name string Oui Nom.
clientId integer · int64 Non Nom du client.
{
  "name": "Example",
  "id": 1001,
  "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_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.

400error_tag_id_and_name_required
ID et nom de l'étiquette requis

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

400error_tag_id_required
ID de tag requis

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

400error_tag_update_failed
Échec de la mise à jour du tag avec l'id : {0}

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

DELETE

Mise à jour de la balise 1

/api/tag/{tagId}
Token avec accès à l'écriture

Mise à jour de la balise 1 à l'aide de DELETE /api/tag/{tagId}.

Parametres de parcours

ChampTypeObligatoireDescription
tagId integer · int64 Oui - Je vous ai identifié.
curl --request DELETE 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200

La réponse n'a pas de corps.

Les erreurs3

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.

PUT

Lier la balise au produit

/api/tag/product/{tagId}/{productId}
Token avec accès à l'écriture

Lier la balise au produit en utilisant PUT /api/tag/product/{tagId}/{productId}.

Parametres de parcours

ChampTypeObligatoireDescription
tagId integer · int64 Oui - Je vous ai identifié.
productId integer · int64 Oui Identification du produit.
curl --request PUT 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200

La réponse n'a pas de corps.

Les erreurs6

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_duplicate_tag_association
L'étiquette est déjà associée au produit

error spécifique au point final. Utilisez le code error_duplicate_tag_association 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.

400error_tag_and_product_id_required
étiquette et ID de produit requis

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

DELETE

Un lier la balise au produit

/api/tag/product/{tagId}/{productId}
Token avec accès à l'écriture

Un lier la balise à un produit en utilisant DELETE /api/tag/product/{tagId}/{productId}.

Parametres de parcours

ChampTypeObligatoireDescription
tagId integer · int64 Oui - Je vous ai identifié.
productId integer · int64 Oui Identification du produit.
curl --request DELETE 'https://api.selsup.ru/api/tag/product/1001/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_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.

400error_tag_and_model_id_required
ID du tag et ID du modèle requis

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

PUT

Lier la balise au modèle

/api/tag/model/{tagId}/{modelId}
Token avec accès à l'écriture

Lier la balise à un modèle à l'aide de PUT /api/tag/model/{tagId}/{modelId}.

Parametres de parcours

ChampTypeObligatoireDescription
tagId integer · int64 Oui - Je vous ai identifié.
modelId integer · int64 Oui Nom de modèle.
curl --request PUT 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200

La réponse n'a pas de corps.

Les erreurs6

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_duplicate_tag_association
L'étiquette est déjà associée au produit

error spécifique au point final. Utilisez le code error_duplicate_tag_association 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.

400error_tag_and_model_id_required
ID du tag et ID du modèle requis

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

DELETE

Un lien avec le modèle

/api/tag/model/{tagId}/{modelId}
Token avec accès à l'écriture

Un lier la balise à un modèle en utilisant DELETE /api/tag/model/{tagId}/{modelId}.

Parametres de parcours

ChampTypeObligatoireDescription
tagId integer · int64 Oui - Je vous ai identifié.
modelId integer · int64 Oui Nom de modèle.
curl --request DELETE 'https://api.selsup.ru/api/tag/model/1001/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_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.

400error_tag_and_model_id_required
ID du tag et ID du modèle requis

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

POST

Créer une balise

/api/tag
Token avec accès à l'écriture

Créer une balise à l'aide de POST /api/tag.

Organisme de demande

application/json
champs d'objetProductTag
ChampTypeObligatoireDescription
id integer · int64 Non Id.
name string Oui Nom.
clientId integer · int64 Non Nom du client.
curl --request POST 'https://api.selsup.ru/api/tag' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

Réponse réussie

200
champs d'objet ProductTag
ChampTypeObligatoireDescription
id integer · int64 Non Id.
name string Oui Nom.
clientId integer · int64 Non Nom du client.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
Les erreurs6

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_duplicate_tag_name
Un tag avec ce nom existe déjà : {0}

error spécifique au point final. Utilisez le code error_duplicate_tag_name 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.

400error_tag_name_required
Nom d'étiquette requis

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

GET

Trouver les balises

/api/tag/find
Token avec accès à la lecture

Trouver les balises à l'aide de GET /api/tag/find.

Paramètres de requête

ChampTypeObligatoireDescription
query string Non Je me demande.
productId integer · int64 Non Identification du produit.
limit integer · int32 Non La limite.
page integer · int32 Non Page. Je suis là.
count boolean Non Je compte.
sortBy stringID, NAME Non On est sortis.
ascending boolean Non Il monte.
curl --request GET 'https://api.selsup.ru/api/tag/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200
champs d'objet FindResponseProductTag
ChampTypeObligatoireDescription
rows ProductTag[] Non Les rangées.
Structure des éléments de l'array ProductTag
ChampTypeObligatoireDescription
id integer · int64 Non Id.
name string Oui Nom.
clientId integer · int64 Non Nom du client.
{
  "rows": "string"
}
Les erreurs4

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_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

Trouver les balises modèle

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

Trouver les balises de modèle à l'aide de GET /api/tag/find/{modelId}.

Parametres de parcours

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

Réponse réussie

200
champs d'objet FindResponseProductTagInfo
ChampTypeObligatoireDescription
rows ProductTagInfo[] Non Les rangées.
Structure des éléments de l'array ProductTagInfo
ChampTypeObligatoireDescription
productId integer · int64 Non Identification du produit.
productTags ProductTag[] Non Étiquettes de produit.
Structure des éléments de l'array ProductTag
ChampTypeObligatoireDescription
id integer · int64 Non Id.
name string Oui Nom.
clientId integer · int64 Non Nom du client.
{
  "rows": "string"
}
Les erreurs4

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