SelSup Developers

Le public API · API Référence

Les médias

Les points de terminaison pour les médias, 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/media/order/{orderId}/videoStableDé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/media/order/{orderId}/video

Flux de travail prêts à l'emploi

Flux de travail prêts à l'emploi

01

Commencez à utiliser Media

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.

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

POST

Télécharger la commande de collecte de vidéos

/api/media/order/{orderId}/video
Token avec accès à l'écriture

Télécharger la commande de collecte de vidéos à l'aide de POST /api/media/order/{orderId}/video.

Parametres de parcours

ChampTypeObligatoireDescription
orderId integer · int64 Oui Nom de commande.
curl --request POST 'https://api.selsup.ru/api/media/order/1001/video' \
  --header 'Authorization: YOUR_API_TOKEN'

Réponse réussie

200

La réponse n'a pas de corps.

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_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_order_not_found
Commande non trouvée

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

400error_storage_size_exceeded
Vous avez dépassé la limite de taille de stockage de fichiers : {limit} Mo

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