Prise en main

Ce guide vous aidera à vous familiariser avec l'environnement de développement StockTicket.

Introduction

L'environnement de développement StockTicket est conçu pour permettre aux développeurs de créer, tester et déployer des modules et des services complémentaires en utilisant les API et les outils fournis par StockTicket. Pour cela, StockTicket fournit plusieurs outils:
- une API client StockTicket : un ensemble de points d'accès RESTful/JSON permettant aux applications clientes d'intérroger les catalogues d'événements, et de contruire des commandes de bout en bout.
- une API d'administration StockTicket : un ensemble de points d'accès RESTful/JSON permettant d'interagir avec les fonctionnalités de gestion de la plateforme StockTicket.
- la possibilité de développer des modules : des applications web externes utilisées pour étendre les fonctionnalités de la plateforme et pouvant être s'intégrer dans l'interface utilisateur StockTicket.

Concepts clés

Sécurité/Identification

L'utilisation des APIs StockTicket nécessite une authentification via des clés d'API.
Chaque requête doit inclure une clé dans une entête HTTP pour identifier l'appelant effectuant la requête et le contexte d'appel.

Afin d'obtenir une clé d'API, vous devez créer un compte sur la plateforme StockTicket.
Vos clés API confèrent de nombreux privilèges ; veillez donc à les protéger ! Ne partagez pas vos clés API secrètes dans des espaces publics tels que GitHub, le code côté client, etc.

Toutes les requêtes API doivent être effectuées via HTTPS . Les appels effectués via HTTP standard échoueront. Les requêtes API sans authentification échoueront également.

Pour plus de détails sur le mécanisme d'authentification, consultez la documentation Authentification.

Accès aux API

Les documentations dynamiques des API StockTicket sont accessibles via Swagger UI, vous permettant de parcourir et d'interagir avec les ressources.

Url de la plateforme de développement: Swagger UI

Pour commencer à utiliser les API StockTicket, créez un compte StockTicket.

Requêtes

...

Réponses

...

Codes de statut HTTP

...

Structure des réponses de type liste

Les réponses de l’API retournant une liste d’objets utilisent un format standardisé pour retourner les ensembles d'objets d'un même type (Ex : type_objet) ListResult<type_objet>.
Ce format permet d'homogénéiser la gestion des collections, notamment pour la pagination.

Structure générale :

{ 
    "totalCount": 123, // Nombre total d'enregistrements (ou -1 si inconnu) 
    "list": [ /* liste des objets retournés */ ] 
}

• totalCount : Nombre total d’enregistrements dans la source de données, avant pagination. Peut valoir -1 si ce nombre n’est pas connu.
• list : Tableau contenant les objets du type demandé, correspondant à la page courante si la réponse est paginée.

Exemple de réponse :

{ "totalCount": 2, "list": [ { "id": 1, "nom": "Exemple 1" }, { "id": 2, "nom": "Exemple 2" } ] }