Créer un événement
POST
https://api-v2.test.eldowallet.fr/events
Crée un événement, c'est-à-dire le modèle de billet (nom, dates, lieux, couleurs, bannière) utilisé par tous ses passes. La requête est envoyée en multipart/form-data et renvoie l'événement créé.
À retenir
- 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. - Utilise
barcodeType(et nonbarcodeFormatcomme les coupons, transports et hôtels). En multipart, les objets imbriqués (date,locations,colors,security) s'envoient en chaîne JSON.date.startDatedoit précéderendDate, etdoorOpeningHourprécéderstartDate.priceva de 0 à 9 999,99.contactPhonedoit être au format international (+…).
Requête
header parameters
x-langstringLangue des messages d'erreur et des textes renvoyés : `fr` ou `en`.enum:en,frdefault:"en"
Body
multipart/form-data requiredstripstring <binary> requiredbarcodeTypestring requiredenum:AZTEC,CODE_128,PDF_417,QR_CODE,NONEnamestring requiredlocationsobject[]longitudenumber requiredlatitudenumber requiredaddressstring requiredmaxLength: 500locationNamestring requiredmaxLength: 500
dateobjectstartDatestring <date-time>endDatestring <date-time>doorOpeningHourstring <date-time>
pricenumbermin: 0max: 9999.99gainUnitstringenum:NONE,EURO,USD,MAD,POINTSdescriptionstringtermsstringsubscriptionMessagestringemailSubscriptionMessagestringcontactPhonestringpattern:^\+(?:[0-9] ?){6,14}[0-9]$emailstring <email>websitestring <uri>colorsobject requiredbackgroundColorstring requiredlabelColorstring requiredforegroundColorstring required
securityobjectenableOneTimeUsebooleandisableIOSPassSharingbooleandisablePassLinkSharingbooleandisableMultipleHoldersbooleanenableSecurityAnimationbooleanenableRotatingBarcodeboolean
PKTextAlignmentLeftstringenum:CHAIR,ACCESS,PRICE,ZONE,INACTIVEPKTextAlignmentCenterstringenum:ROW,INACTIVEPKTextAlignmentRightstringenum:INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT
Réponses
- 201
- 400
- 401
- 403
- 404
- 415
- 500
- 503
Schéma
application/jsonstatusstring requiredenum:PENDING,ACTIF,ENDEDdefault:"PENDING"walletoneOf required- Wallet
namestring requiredlogostring requirediconstring requiredandroidLogostringdisplayIdentifiantboolean requiredpassBuilderPassTemplateIdstringpassBuilderBusinessIdstringpassBuilderTokenstringidentifierstring requiredidentifierQrstring requiredaddressstringwebsitestring requiredservicePhonestring requiredbusinessPhonestring requiredsocialMediaobject requiredlinkedinstringfacebookstringinstagramstringtiktokstringtwitterstringyoutubestringsnapchatstringpintereststringredditstringwhatsappstringtelegramstring
additionalContactsobject[] requiredtitlestring requiredvaluestring requiredkindstring requiredenum:URL,PHONE,EMAIL
termsAndConditionsobject requiredtypestring requiredenum:PDF,URL,NONEcustomUrlstringpdfUrlstring
webHookUrlstring requiredrootDomainstring requiredtimezonestringallowedPassesstring[] requiredenum:ALL,EVENT_TICKET,TRANSIT,CINEMA,BOARDING_PASS,COUPON,GENERIC,STORE_CARD,OFFER,HOTELexpiredCleanupEnabledboolean required_idstring requiredcreatedAtstring <date-time> requiredupdatedAtstring <date-time> required
- option 2
- Wallet
barcodeTypestring requiredenum:AZTEC,CODE_128,PDF_417,QR_CODE,NONEnamestring requiredlocationsobject[] requiredlongitudenumberlatitudenumberaddressstringlocationNamestring
dateobjectstartDatestring <date-time>endDatestring <date-time>doorOpeningHourstring <date-time>
pricenumbergainUnitstringenum:NONE,EURO,USD,MAD,POINTSdescriptionstringtermsstringsubscriptionMessagestring requiredemailSubscriptionMessagestring requiredcontactPhonestringemailstringwebsitestringcolorsobject requiredlabelColorstring requiredbackgroundColorstring requiredforegroundColorstring required
securityobjectenableOneTimeUsebooleandisableIOSPassSharingbooleandisablePassLinkSharingbooleandisableMultipleHoldersbooleanenableSecurityAnimationbooleanenableRotatingBarcodeboolean
passBuilderPassTemplateIdstringstripstringPKTextAlignmentLeftstringenum:CHAIR,ACCESS,PRICE,ZONE,INACTIVEPKTextAlignmentCenterstringenum:ROW,INACTIVEPKTextAlignmentRightstringenum:INACTIVE,TYPE,SEAT,PLACE,ARMCHAIR,LOCATION,PORT_idstring requiredcreatedAtstring <date-time> requiredupdatedAtstring <date-time> required
VALIDATION_ERROR · INVALID_JSON · INVALID_MULTIPART
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNAUTHORIZED
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
FORBIDDEN
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
MODEL_NOT_FOUND
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNSUPPORTED_MEDIA_TYPE
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
UNKNOWN_ERROR
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email
PASS_BUILDER_ERROR
Schéma
application/jsonmessagestring requiredexample:Promo code already existserrorCodestring requiredexample:400:PROMO_CODE_ALREADY_EXISTSpathstring requiredexample:/couponsdatestring <date-time> requireddetailsobjectvalidationErrorsobject[]fieldstringexample:emailmessagestringexample:email must be an email