Cadre d’utilisation de l’API

<aside> ☝ Il est rappelé que les offres créées par les acteurs culturels par API doivent respecter les Conditions Générales d’Utilisation.

</aside>

Distinction entre les offres soumises ou non à la présentation d’un billet

On distingue les offres d’événements selon leur soumission à la présentation d’un billet.

<aside> 📌 La publication par l’API offres individuelles événements d’une offre pour un événement soumis à la présentation d’un billet impose la gestion en temps réel des réservations pour cet événement et l’envoi des informations des informations des billets vers l’application via l’API réservations individuelles.

</aside>

Les offres d’événements créées par API et le portail pass Culture pro

Les offres créées par API sont visibles sur le portail pass Culture pro. En revanche, ces offres ne sont pas manuellement éditables sur le portail pass Culture pro, à l’exception de quelques actions :

1. Désactiver une offre
2. Éditer les conditions d’accessibilité
3. Éditer le lien pour le grand public

Schémas et Swagger

L’ensembles des routes et schémas sont détaillés dans le Swagger :

Pour l’environnement d’intégration

Swagger UI

Pour l’environnement de production

Swagger UI

En parallèle, une documentation détaillée du fonctionnement de l’API ainsi que l’illustration des schémas de base de données par des exemples est fournie ci-après.

Glossaire

commun aux offres Produits et Événements

• Offre produit : les offres produits peuvent être physiques (un CD, un instrument, etc) ou numériques (un abonnement en ligne, un e-book, etc)
• Offre évènement : les offres évènements peuvent être physiques (Représentation, Salon, etc.) ou numériques (Concert livestream, Recontre en ligne, etc.)
• venue_id : ce paramètre identifie de manière unique un lieu culturel. C'est donc le lieu visé pour publication, consultation ou modification de l’offre. Vous pouvez récupérer l’ensemble des venue_id associés à votre clé API via l’appel /public/offers/v1/offerer_venues
• api_key : voir ‣
• imageFile (optionnel) : Fichier de l’image à ajouter à une offre. Le fichier doit être encodé en base64 et contenir une image au format jpg ou png de exactement 400 pixels de large pour 600 pixels de haut.
• imageCredit Les crédits concernant l’image (auteur, ayant droit etc…). Cette propriété est obligatoire si la propriété imageFile est renseignée et interdite sinon.

propre aux offres Événements

• hasTicket : permet d’indiquer si l’événement est soumis ou non à la présentation d’un billet
• enableDoubleBookings : permet d’indiquer si l’événement accepte les réservations duo

<aside> ℹ️ L'option "Duo" permet aux jeunes, s'ils le souhaitent, de réserver deux places pour un événement : voir l’article dédié sur la FAQ.

</aside>