SelSup Developers

Le public API · API Référence

Job

Les points de fin pour le travail, y compris les itinéraires exacts, les paramètres, les organismes de demande et les schémas de réponse extensibles.

3 points de fin/api/jobStableDé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/job

Flux de travail prêts à l'emploi

Flux de travail prêts à l'emploi

01

Commencez à utiliser Job

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.

Job11 champs
idinteger · int32

Id.

namestring

Nom.

categoryClassstring

Classe de catégorie.

clientIdinteger · int64

Nom du client.

deletedboolean

Il a été supprimé.

positionIdinteger · int64

Identification de la position.

versionIdinteger · int64

- La version ID.

createdUserstring

Créé par l'utilisateur.

createdDatestring · date-time

Date créée.

pricenumber · double

Le prix.

tariffsJobTariff[]

Les tarifs.

JobTariff8 champs
idinteger · int64

Id.

jobIdinteger · int32

Nom de travail.

pricenumber · double

Le prix.

brandIdinteger · int32

Nom de marque.

categoryClassstring

Classe de catégorie.

categoryIdinteger · int32

Identification de catégorie

priorityinteger · int32

La priorité.

productIdinteger · int64

Identification du 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

Mettez le travail

/api/job/{jobId}
Token avec accès à l'écriture

Mettre le travail à l'aide de PUT /api/job/{jobId}.

Parametres de parcours

ChampTypeObligatoireDescription
jobId integer · int64 Oui Nom de travail.

Organisme de demande

application/json
champs d'objetJob
ChampTypeObligatoireDescription
id integer · int32 Non Id.
name string Non Nom.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Non Classe de catégorie.
clientId integer · int64 Non Nom du client.
deleted boolean Non Il a été supprimé.
positionId integer · int64 Non Identification de la position.
versionId integer · int64 Non - La version ID.
createdUser string Non Créé par l'utilisateur.
createdDate string · date-time Non Date créée.
price number · double Non Le prix.
tariffs JobTariff[] Non Les tarifs.
Structure des éléments de l'array JobTariff
ChampTypeObligatoireDescription
id integer · int64 Non Id.
jobId integer · int32 Non Nom de travail.
price number · double Non Le prix.
brandId integer · int32 Non Nom de marque.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Non Classe de catégorie.
categoryId integer · int32 Non Identification de catégorie
priority integer · int32 Non La priorité.
productId integer · int64 Non Identification du produit.
curl --request PUT 'https://api.selsup.ru/api/job/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}'

Réponse réussie

200
champs d'objet Job
ChampTypeObligatoireDescription
id integer · int32 Non Id.
name string Non Nom.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Non Classe de catégorie.
clientId integer · int64 Non Nom du client.
deleted boolean Non Il a été supprimé.
positionId integer · int64 Non Identification de la position.
versionId integer · int64 Non - La version ID.
createdUser string Non Créé par l'utilisateur.
createdDate string · date-time Non Date créée.
price number · double Non Le prix.
tariffs JobTariff[] Non Les tarifs.
Structure des éléments de l'array JobTariff
ChampTypeObligatoireDescription
id integer · int64 Non Id.
jobId integer · int32 Non Nom de travail.
price number · double Non Le prix.
brandId integer · int32 Non Nom de marque.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Non Classe de catégorie.
categoryId integer · int32 Non Identification de catégorie
priority integer · int32 Non La priorité.
productId integer · int64 Non Identification du produit.
{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}
Les erreurs14

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_category_class
Classe non spécifiée

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

400error_empty_job_price
Prix pour l'exécution du travail non spécifié

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

400error_empty_position
Poste non spécifié

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

400error_empty_tariff_price
Prix non spécifié pour le tarif n°{position}

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

400error_empty_tariff_priority
Priorité non spécifiée pour le tarif

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

400error_empty_tariffs
Tarifs non spécifiés

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

400error_job_already_exists
La tâche avec le nom {jobName} existe déjà

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

400error_job_modified
Les données du travail sont déjà mises à jour. Actualisez la page.

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

400error_job_tariff_wrong_product_id
Identifiant du produit incorrectement spécifié : {id}

error spécifique au point final. Utilisez le code error_job_tariff_wrong_product_id 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_subscription_expired
Votre abonnement a expiré. Veuillez payer l'abonnement pour continuer à utiliser le service.

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

DELETE

Enlevez Job

/api/job/{jobId}
Token avec accès à l'écriture

Supprimer le travail à l'aide de DELETE /api/job/{jobId}.

Parametres de parcours

ChampTypeObligatoireDescription
jobId integer · int32 Oui Nom de travail.

Paramètres de requête

ChampTypeObligatoireDescription
deleted boolean Oui Il a été supprimé.
curl --request DELETE 'https://api.selsup.ru/api/job/1001?deleted=false' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200
"string"
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_job_modified
Les données du travail sont déjà mises à jour. Actualisez la page.

error spécifique au point final. Utilisez le code error_job_modified 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_subscription_expired
Votre abonnement a expiré. Veuillez payer l'abonnement pour continuer à utiliser le service.

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

POST

Post-emploi

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

Afficher un emploi à l'aide de POST /api/job/.

Organisme de demande

application/json
champs d'objetJob
ChampTypeObligatoireDescription
id integer · int32 Non Id.
name string Non Nom.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Non Classe de catégorie.
clientId integer · int64 Non Nom du client.
deleted boolean Non Il a été supprimé.
positionId integer · int64 Non Identification de la position.
versionId integer · int64 Non - La version ID.
createdUser string Non Créé par l'utilisateur.
createdDate string · date-time Non Date créée.
price number · double Non Le prix.
tariffs JobTariff[] Non Les tarifs.
Structure des éléments de l'array JobTariff
ChampTypeObligatoireDescription
id integer · int64 Non Id.
jobId integer · int32 Non Nom de travail.
price number · double Non Le prix.
brandId integer · int32 Non Nom de marque.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Non Classe de catégorie.
categoryId integer · int32 Non Identification de catégorie
priority integer · int32 Non La priorité.
productId integer · int64 Non Identification du produit.
curl --request POST 'https://api.selsup.ru/api/job/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}'

Réponse réussie

200
champs d'objet Job
ChampTypeObligatoireDescription
id integer · int32 Non Id.
name string Non Nom.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Non Classe de catégorie.
clientId integer · int64 Non Nom du client.
deleted boolean Non Il a été supprimé.
positionId integer · int64 Non Identification de la position.
versionId integer · int64 Non - La version ID.
createdUser string Non Créé par l'utilisateur.
createdDate string · date-time Non Date créée.
price number · double Non Le prix.
tariffs JobTariff[] Non Les tarifs.
Structure des éléments de l'array JobTariff
ChampTypeObligatoireDescription
id integer · int64 Non Id.
jobId integer · int32 Non Nom de travail.
price number · double Non Le prix.
brandId integer · int32 Non Nom de marque.
categoryClass stringSHOES, LIGHT, DRUGS, CAMERA, TYRES, MILK, WATER, TOBACCO, FURS, BEER, BICYCLES, PERFUMES, ELECTRONIC, OTHER, NONE, FOOD, WHEELCHAIRS, OTP, NCP, BIO, ANTISEPTIC, NABEER, SOFTDRINKS, PETFOOD, SEAFOOD, MEAT, TOYS, TITAN, RADIO, OPTIC_FIBER, VEGETABLE_OIL, CONSERVE, VETPHARMA, CHEMISTRY, AUTOFLUIDS, GROCERY, BOOKS, CONSTRUCTION, FIRE, HEATER, CABLERAW, POLYMER, SWEETS, CARPARTS, NATURAL_FUR, NICOTINDEV, GADGETS, FROZEN, FERTILIZERS, HOMEWARE, VETBIO, INDUSTRIAL, PYROTECHNICS Non Classe de catégorie.
categoryId integer · int32 Non Identification de catégorie
priority integer · int32 Non La priorité.
productId integer · int64 Non Identification du produit.
{
  "id": 1001,
  "name": "Example",
  "categoryClass": "SHOES",
  "clientId": 1001,
  "deleted": false,
  "positionId": 1001
}
Les erreurs12

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_category_class
Classe non spécifiée

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

400error_empty_job_price
Prix pour l'exécution du travail non spécifié

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

400error_empty_position
Poste non spécifié

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

400error_empty_tariff_price
Prix non spécifié pour le tarif n°{position}

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

400error_empty_tariff_priority
Priorité non spécifiée pour le tarif

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

400error_empty_tariffs
Tarifs non spécifiés

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

400error_job_already_exists
La tâche avec le nom {jobName} existe déjà

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

400error_job_tariff_wrong_product_id
Identifiant du produit incorrectement spécifié : {id}

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