SelSup Developers

Le public API · API Référence

Fabricants

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

5 points de fin/api/manufacturerStableDé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/manufacturer

Flux de travail prêts à l'emploi

Flux de travail prêts à l'emploi

01

Commencez à utiliser Fabricants

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.

Manufacturer11 champs
manufacturerIdinteger · int32

Identification du fabricant

titlestring

Titre.

namestring

Nom.

Obligatoire
addressstring

Une adresse.

organizationIdinteger · int64

Identification de l'organisation.

clientIdinteger · int64

Nom du client.

read-only
countryIdinteger · int32

Identification du pays.

countryNamestring

Nom du pays.

read-only
innstring

Une auberge.

deletedboolean

Il a été supprimé.

oneCIdstring

Un informateur.

FindResponseManufacturer1 champs
rowsManufacturer[]

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 points de fin

Les points de fin

GET

Obtenez le numéro de fabricant

/api/manufacturer/{manufacturerId}
Token avec accès à la lecture

Obtenez le produit par identifiant en utilisant GET /api/manufacturer/{manufacturerId}.

Parametres de parcours

ChampTypeObligatoireDescription
manufacturerId integer · int32 Oui Identification du fabricant
curl --request GET 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200
champs d'objet Manufacturer
ChampTypeObligatoireDescription
manufacturerId integer · int32 Non Identification du fabricant
title string Non Titre.
name string Oui Nom.
address string Non Une adresse.
organizationId integer · int64 Non Identification de l'organisation.
clientId integer · int64 Non Nom du client.
countryId integer · int32 Non Identification du pays.
countryName string Non Nom du pays.
inn string Non Une auberge.
deleted boolean Non Il a été supprimé.
oneCId string Non Un informateur.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 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_manufacturer_not_found
Fabricant non trouvé : {id}

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

PUT

Mise à jour du fabricant

/api/manufacturer/{manufacturerId}
Token avec accès à l'écriture

Mise à jour du fabricant à l'aide de PUT /api/manufacturer/{manufacturerId}.

Parametres de parcours

ChampTypeObligatoireDescription
manufacturerId integer · int64 Oui Identification du fabricant

Organisme de demande

application/json
champs d'objetManufacturer
ChampTypeObligatoireDescription
manufacturerId integer · int32 Non Identification du fabricant
title string Non Titre.
name string Oui Nom.
address string Non Une adresse.
organizationId integer · int64 Non Identification de l'organisation.
clientId integer · int64 Non Nom du client.
countryId integer · int32 Non Identification du pays.
countryName string Non Nom du pays.
inn string Non Une auberge.
deleted boolean Non Il a été supprimé.
oneCId string Non Un informateur.
curl --request PUT 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

Réponse réussie

200
champs d'objet Manufacturer
ChampTypeObligatoireDescription
manufacturerId integer · int32 Non Identification du fabricant
title string Non Titre.
name string Oui Nom.
address string Non Une adresse.
organizationId integer · int64 Non Identification de l'organisation.
clientId integer · int64 Non Nom du client.
countryId integer · int32 Non Identification du pays.
countryName string Non Nom du pays.
inn string Non Une auberge.
deleted boolean Non Il a été supprimé.
oneCId string Non Un informateur.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 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_empty_manufacturer_name
Nom du fabricant non spécifié

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

400error_manufacturer_already_exist
Un fabricant avec le nom {name} existe déjà

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

Remplisseur du fabricant

/api/manufacturer/{manufacturerId}
Token avec accès à l'écriture

Retirer le fabricant en utilisant DELETE /api/manufacturer/{manufacturerId}.

Parametres de parcours

ChampTypeObligatoireDescription
manufacturerId integer · int32 Oui Identification du fabricant

Paramètres de requête

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

Réponse réussie

200
"string"
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.

POST

Créer le fabricant

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

Créer le fabricant à l'aide de POST /api/manufacturer.

Organisme de demande

application/json
champs d'objetManufacturer
ChampTypeObligatoireDescription
manufacturerId integer · int32 Non Identification du fabricant
title string Non Titre.
name string Oui Nom.
address string Non Une adresse.
organizationId integer · int64 Non Identification de l'organisation.
clientId integer · int64 Non Nom du client.
countryId integer · int32 Non Identification du pays.
countryName string Non Nom du pays.
inn string Non Une auberge.
deleted boolean Non Il a été supprimé.
oneCId string Non Un informateur.
curl --request POST 'https://api.selsup.ru/api/manufacturer' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

Réponse réussie

200
champs d'objet Manufacturer
ChampTypeObligatoireDescription
manufacturerId integer · int32 Non Identification du fabricant
title string Non Titre.
name string Oui Nom.
address string Non Une adresse.
organizationId integer · int64 Non Identification de l'organisation.
clientId integer · int64 Non Nom du client.
countryId integer · int32 Non Identification du pays.
countryName string Non Nom du pays.
inn string Non Une auberge.
deleted boolean Non Il a été supprimé.
oneCId string Non Un informateur.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 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_empty_manufacturer_name
Nom du fabricant non spécifié

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

400error_manufacturer_already_exist
Un fabricant avec le nom {name} existe déjà

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

GET

Trouver

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

Trouver en utilisant GET /api/manufacturer/find.

Paramètres de requête

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

Réponse réussie

200
champs d'objet FindResponseManufacturer
ChampTypeObligatoireDescription
rows Manufacturer[] Non Les rangées.
Structure des éléments de l'array Manufacturer
ChampTypeObligatoireDescription
manufacturerId integer · int32 Non Identification du fabricant
title string Non Titre.
name string Oui Nom.
address string Non Une adresse.
organizationId integer · int64 Non Identification de l'organisation.
clientId integer · int64 Non Nom du client.
countryId integer · int32 Non Identification du pays.
countryName string Non Nom du pays.
inn string Non Une auberge.
deleted boolean Non Il a été supprimé.
oneCId string Non Un informateur.
{
  "rows": "string"
}
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_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.

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.