SelSup Developers

Le public API · API Référence

Réservation des factures

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

1 points de fin/api/billing/findStableDé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/billing/find

Flux de travail prêts à l'emploi

Flux de travail prêts à l'emploi

01

Commencez à utiliser la facturation

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.

Billing17 champs
idinteger · int64

Id.

namestring

Nom.

productIdinteger · int64

Identification du produit.

itemIdinteger · int64

Le numéro de l'article.

orderIdinteger · int64

Nom de commande.

pricenumber · double

Le prix.

volumeinteger · int32

Le volume.

weightinteger · int32

Le poids.

quantityinteger · int32

La quantité.

totalPricenumber · double

Le prix total.

tariffIdinteger · int64

Identification des tarifs douaniers.

linkedClientIdinteger · int64

Identification du client liée.

clientIdinteger · int64

Nom du client.

fromstring · date-time

- De chez vous.

tostring · date-time

À vous.

datestring · date-time

Une date.

userIdinteger · int64

Identification de l'utilisateur.

FindResponseBilling1 champs
rowsBilling[]

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 une opération de facturation

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

Obtenez une opération de facturation à l'aide de GET /api/billing/find.

Paramètres de requête

ChampTypeObligatoireDescription
from string · date-time Non - De chez vous.
to string · date-time Non À vous.
limit integer · int32 Non La limite.
page integer · int32 Non Page. Je suis là.
count boolean Non Je compte.
sortBy string Non On est sortis.
ascending boolean Non Il monte.
curl --request GET 'https://api.selsup.ru/api/billing/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200
champs d'objet FindResponseBilling
ChampTypeObligatoireDescription
rows Billing[] Non Les rangées.
Structure des éléments de l'array Billing
ChampTypeObligatoireDescription
id integer · int64 Non Id.
name string Non Nom.
productId integer · int64 Non Identification du produit.
itemId integer · int64 Non Le numéro de l'article.
orderId integer · int64 Non Nom de commande.
price number · double Non Le prix.
volume integer · int32 Non Le volume.
weight integer · int32 Non Le poids.
quantity integer · int32 Non La quantité.
totalPrice number · double Non Le prix total.
tariffId integer · int64 Non Identification des tarifs douaniers.
linkedClientId integer · int64 Non Identification du client liée.
clientId integer · int64 Non Nom du client.
from string · date-time Non - De chez vous.
to string · date-time Non À vous.
date string · date-time Non Une date.
userId integer · int64 Non Identification de l'utilisateur.
{
  "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.