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/keyword
Flux de travail prêts à l'emploi
Flux de travail prêts à l'emploi
01
Commencez à utiliser les mots clés
Utilisez un jeton API dédié et validez d'abord les opérations de lecture avec les données de test.
Gardez le jeton côté serveur et envoyez-le dans l'en-tête Authorization.
Vérifiez les paramètres requis et élargissez le schéma de demande ou de réponse.
Traiter l'état HTTP et le champ stable error dans les erreurs d'application.
Les modèles sont énumérés une fois ici et peuvent également être étendus directement depuis les terminaux qui les utilisent.
Keyword3 champs
idinteger · int64
Id.
namestring
Nom.
usingQuantityinteger · int32
En utilisant la quantité.
KeywordGroup3 champs
idinteger · int64
Id.
namestring
Nom.
keywordsKeyword[]
Les mots clés.
KeywordAndGroup2 champs
keywordKeyword[]
Le mot clé.
groupKeywordGroup[]
Groupe.
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
GET
Obtenez le mot clé du groupe
/api/keyword/group/{groupId}
Token avec accès à la lecture
Obtenez le mot clé du groupe à l'aide de GET /api/keyword/group/{groupId}.
Parametres de parcours
Champ
Type
Obligatoire
Description
groupId
integer · int64
Oui
Identification du groupe.
curl --request GET 'https://api.selsup.ru/api/keyword/group/1001' \
--header 'Authorization: YOUR_API_TOKEN'
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
Modifier le groupe de mots clés par ID
/api/keyword/group/{groupId}
Token avec accès à l'écriture
Modifier le groupe de mots clés par id à l'aide de PUT /api/keyword/group/{groupId}.
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.
DELETE
Supprimer le groupe de mots clés
/api/keyword/group/{groupId}
Token avec accès à l'écriture
Supprimer le groupe de mots clés à l'aide de DELETE /api/keyword/group/{groupId}.
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
Ajouter le groupe de mots clés
/api/keyword/add
Token avec accès à l'écriture
Ajouter le groupe de mots clés à l'aide de PUT /api/keyword/add.
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.
GET
Trouvez le groupe de mots clés
/api/keyword/group
Token avec accès à la lecture
Obtenez le groupe de mots clés à l'aide de GET /api/keyword/group.
curl --request GET 'https://api.selsup.ru/api/keyword/group' \
--header 'Authorization: YOUR_API_TOKEN'
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.
POST
Créer un groupe de mots clés
/api/keyword/group
Token avec accès à l'écriture
Créer un groupe de mots clés à l'aide de POST /api/keyword/group.
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.
DELETE
Supprimer les groupes de mots clés
/api/keyword/group
Token avec accès à l'écriture
Supprimer les groupes de mots clés à l'aide de DELETE /api/keyword/group.
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.
POST
Fusion des groupes de mots clés
/api/keyword/group/merge
Token avec accès à l'écriture
Fusion de groupes de mots clés à l'aide de POST /api/keyword/group/merge.
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_empty_group_name
Le nom du groupe de mots-clés ne peut pas être vide
error spécifique au point final. Utilisez le code error_empty_group_name stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_keywords_groups
Le groupe de mots-clés est vide
error spécifique au point final. Utilisez le code error_empty_keywords_groups stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_need_at_least_two_groups
au moins deux groupes requis
error spécifique au point final. Utilisez le code error_need_at_least_two_groups 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
Obtenez le mot clé pour entité
/api/keyword/{modelId}
Token avec accès à la lecture
Obtenez le mot clé pour l'entité à l'aide de GET /api/keyword/{modelId}.
Parametres de parcours
Champ
Type
Obligatoire
Description
modelId
integer · int64
Oui
Nom de modèle.
curl --request GET 'https://api.selsup.ru/api/keyword/1001' \
--header 'Authorization: YOUR_API_TOKEN'
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.
GET
Trouver le groupe de mots clés
/api/keyword/group/find
Token avec accès à la lecture
Trouver le groupe de mots clés à l'aide de GET /api/keyword/group/find.
Paramètres de requête
Champ
Type
Obligatoire
Description
word
string
Oui
Je vous le dis.
curl --request GET 'https://api.selsup.ru/api/keyword/group/find?word=string' \
--header 'Authorization: YOUR_API_TOKEN'
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.
DELETE
Supprimer le groupe de mots clés de l'entité
/api/keyword/model/{modelId}
Token avec accès à l'écriture
Supprimer le groupe de mots clés de l'entité en utilisant DELETE /api/keyword/model/{modelId}.
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.
DELETE
Supprimer le mot clé du groupe
/api/keyword/group/{groupId}/keywords
Token avec accès à l'écriture
Supprimer le mot clé du groupe à l'aide de DELETE /api/keyword/group/{groupId}/keywords.
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.