Créer un modèle de transport

POST

https://api-v2.test.eldowallet.fr/transits

Crée un modèle de transport (bus, train, bateau, avion, tram ou générique) et son modèle de pass Apple Wallet et Google Wallet. Envoyez la requête en multipart/form-data avec l'image strip (obligatoire) ; le number du modèle sert de numéro de trajet par défaut des passes.

À retenir

• Le wallet doit avoir le type de pass TRANSIT activé.
• Corps en multipart/form-data : les objets imbriqués (colors, security, locations…) s'envoient en chaîne JSON, les booléens en "true"/"false". Images : PNG ou JPEG, 1 Ko à 5 Mo.

Requête

header parameters

• x-lang string
  Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
  enum: en, frdefault: "en"

Body multipart/form-data required

• strip string <binary> required
• terms string required
• customerServiceNumber string
• originStationCode string required
• originName string required
• destinationStationCode string required
• destinationName string required
• departureTime string requiredpattern: ^([01]\d|2[0-3]):([0-5]\d)(Z|([+-]([01]\d|2[0-3]):[0-5]\d))?$
• arrivalTime string requiredpattern: ^([01]\d|2[0-3]):([0-5]\d)(Z|([+-]([01]\d|2[0-3]):[0-5]\d))?$
• tarif string
• details string required
• number number required
• type string requiredenum: Bus, Boat, Train, Air, Generic, Tram
• gateName stringenum: N_CABINE, N_VOYAGE, PLAQUE
• seatName stringenum: N_CABINE, N_VOYAGE, PLAQUE
• emailSubscriptionMessage string
• subscriptionMessage string
• barcodeFormat string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
• locations object[]
  • latitude number required
  • longitude number required
• colors object required
  • backgroundColor string required
  • labelColor string required
  • foregroundColor string required
• security object
  • enableOneTimeUse boolean
  • disableIOSPassSharing boolean
  • disablePassLinkSharing boolean
  • disableMultipleHolders boolean
  • enableSecurityAnimation boolean
  • enableRotatingBarcode boolean
• displayOptions object
  • hideTarif boolean
  • hideStationCodes boolean
  • hideTripNumber boolean
• iosHeader object
  • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
  • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
  • customLabel string
  • customValue string

Réponses

201

Schéma application/json

• wallet oneOf required
  • Wallet
    • name string required
    • logo string required
    • icon string required
    • androidLogo string
    • displayIdentifiant boolean required
    • passBuilderPassTemplateId string
    • passBuilderBusinessId string
    • passBuilderToken string
    • identifier string required
    • identifierQr string required
    • address string
    • website string required
    • servicePhone string required
    • businessPhone string required
    • socialMedia object required
      • linkedin string
      • facebook string
      • instagram string
      • tiktok string
      • twitter string
      • youtube string
      • snapchat string
      • pinterest string
      • reddit string
      • whatsapp string
      • telegram string
    • additionalContacts object[] required
      • title string required
      • value string required
      • kind string requiredenum: URL, PHONE, EMAIL
    • termsAndConditions object required
      • type string requiredenum: PDF, URL, NONE
      • customUrl string
      • pdfUrl string
    • webHookUrl string required
    • rootDomain string required
    • timezone string
    • allowedPasses string[] requiredenum: ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL
    • expiredCleanupEnabled boolean required
    • _id string required
    • createdAt string <date-time> required
    • updatedAt string <date-time> required
  • option 2
• barcodeFormat string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
• terms string required
• emailSubscriptionMessage string
• subscriptionMessage string
• locations object[]
  • longitude number
  • latitude number
  • relevantName string
  • relevantAddress string
• colors object required
  • labelColor string required
  • backgroundColor string required
  • foregroundColor string required
• strip string
• customerServiceNumber string
• originStationCode string required
• originName string required
• destinationStationCode string required
• destinationName string required
• departureTime string required
• arrivalTime string required
• tarif string
• details string required
• number string required
• type string requiredenum: Bus, Boat, Train, Air, Generic, Tram
• gateName stringenum: N_CABINE, N_VOYAGE, PLAQUE
• seatName stringenum: N_CABINE, N_VOYAGE, PLAQUE
• security object
  • enableOneTimeUse boolean
  • disableIOSPassSharing boolean
  • disablePassLinkSharing boolean
  • disableMultipleHolders boolean
  • enableSecurityAnimation boolean
  • enableRotatingBarcode boolean
• passBuilderPassTemplateId string
• customBackFields string[]
  Définitions des champs de verso au niveau du modèle (clé, libellé et type). Les valeurs propres à chaque pass sont stockées sur le pass.
• displayOptions object
  • hideTarif boolean
  • hideStationCodes boolean
  • hideTripNumber boolean
• iosHeader object
  • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
  • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
  • customLabel string
  • customValue string
• _id string required
• createdAt string <date-time> required
• updatedAt string <date-time> required

400

VALIDATION_ERROR · INVALID_JSON · INVALID_MULTIPART

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

401

UNAUTHORIZED

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

415

UNSUPPORTED_MEDIA_TYPE

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email