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.
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.
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.
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}.
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}.
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
Champ
Type
Obligatoire
Description
modelId
integer · int64
Oui
Nom de modèle.
curl --request GET 'https://api.selsup.ru/api/competitor/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.
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.
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.