Les points d'expiration des tests d'hypothèse, y compris les routes exactes, les paramètres, les corps de requête 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/hypothesis
Flux de travail prêts à l'emploi
Flux de travail prêts à l'emploi
01
Commencez à utiliser les tests d' hypothèse
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.
Hypothesis14 champs
idinteger · int32
Id.
namestring
Nom.
previousStartDatestring · date-time
Date de départ précédente.
startDatestring · date-time
Date de début.
endDatestring · date-time
La date de fin.
modelIdinteger · int64
Nom de modèle.
modelArticlestring
Article modèle.
viewIdinteger · int64
Voir l'identifiant.
productIdinteger · int64
Identification du produit.
organizationIdinteger · int64
Identification de l'organisation.
createdDatestring · date-time
Date créée.
createdUserstring
Créé par l'utilisateur.
servicestring
Le service.
successStatusstring
Le statut de succès.
FindResponseHypothesis1 champs
rowsHypothesis[]
Les rangées.
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 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_end_date
Date de fin non spécifiée
error spécifique au point final. Utilisez le code error_empty_end_date stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_name
Nom non spécifié
error spécifique au point final. Utilisez le code error_empty_name stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_start_date
Date de début non spécifiée
error spécifique au point final. Utilisez le code error_empty_start_date stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_end_less_then_start_date
La date de fin doit être postérieure à la date de début
error spécifique au point final. Utilisez le code error_end_less_then_start_date 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
Le code de l'emploi
/api/hypothesis/{id}
Token avec accès à la lecture
Identification utilisant GET /api/hypothesis/{id}.
Parametres de parcours
Champ
Type
Obligatoire
Description
id
integer · int32
Oui
Id.
curl --request GET 'https://api.selsup.ru/api/hypothesis/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_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.
PATCH
Hypothèse de patch
/api/hypothesis/{id}
Token avec accès à l'écriture
Hypothèse de patch à l'aide de PATCH /api/hypothesis/{id}.
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_end_date
Date de fin non spécifiée
error spécifique au point final. Utilisez le code error_empty_end_date stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_id
Identifiant non spécifié
error spécifique au point final. Utilisez le code error_empty_id stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_name
Nom non spécifié
error spécifique au point final. Utilisez le code error_empty_name stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_start_date
Date de début non spécifiée
error spécifique au point final. Utilisez le code error_empty_start_date stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_end_less_then_start_date
La date de fin doit être postérieure à la date de début
error spécifique au point final. Utilisez le code error_end_less_then_start_date 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 l'hypothèse
/api/hypothesis/{id}
Token avec accès à l'écriture
Supprimer l'hypothèse en utilisant DELETE /api/hypothesis/{id}.
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.
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.