Aller au contenu principal

Transit

wallet objectobligatoire
oneOf
namestringobligatoire
logostringobligatoire
iconstringobligatoire
androidLogostring
displayIdentifiantbooleanobligatoire
passBuilderPassTemplateIdstring
passBuilderBusinessIdstring
passBuilderTokenstring
identifierstringobligatoire
identifierQrstringobligatoire
addressstring
websitestringobligatoire
servicePhonestringobligatoire
businessPhonestringobligatoire
socialMedia objectobligatoire
linkedinstring
facebookstring
instagramstring
tiktokstring
twitterstring
youtubestring
snapchatstring
pintereststring
redditstring
whatsappstring
telegramstring
additionalContacts object[]obligatoire
  • Array [
  • titlestringobligatoire
    valuestringobligatoire
    kindstringobligatoire

    Valeurs possibles : [URL, PHONE, EMAIL]

  • ]
  • termsAndConditions objectobligatoire
    typestringobligatoire

    Valeurs possibles : [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringobligatoire
    rootDomainstringobligatoire
    timezonestring
    allowedPassesstring[]obligatoire

    Valeurs possibles : [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanobligatoire
    _idstringobligatoire
    createdAtstring<date-time>obligatoire
    updatedAtstring<date-time>obligatoire
    barcodeFormatstringobligatoire

    Valeurs possibles : [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

    termsstringobligatoire
    emailSubscriptionMessagestring
    subscriptionMessagestring
    locations object[]
  • Array [
  • longitudenumber
    latitudenumber
    relevantNamestring
    relevantAddressstring
  • ]
  • colors objectobligatoire
    labelColorstringobligatoire
    backgroundColorstringobligatoire
    foregroundColorstringobligatoire
    stripstring
    customerServiceNumberstring
    originStationCodestringobligatoire
    originNamestringobligatoire
    destinationStationCodestringobligatoire
    destinationNamestringobligatoire
    departureTimestringobligatoire
    arrivalTimestringobligatoire
    tarifstring
    detailsstringobligatoire
    numberstringobligatoire
    typestringobligatoire

    Valeurs possibles : [Bus, Boat, Train, Air, Generic, Tram]

    gateNamestring

    Valeurs possibles : [N_CABINE, N_VOYAGE, PLAQUE]

    seatNamestring

    Valeurs possibles : [N_CABINE, N_VOYAGE, PLAQUE]

    security object
    enableOneTimeUseboolean
    disableIOSPassSharingboolean
    disablePassLinkSharingboolean
    disableMultipleHoldersboolean
    enableSecurityAnimationboolean
    enableRotatingBarcodeboolean
    passBuilderPassTemplateIdstring
    customBackFieldsstring[]

    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
    hideTarifboolean
    hideStationCodesboolean
    hideTripNumberboolean
    iosHeader object
    labelEnumstringobligatoire

    Valeurs possibles : [FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE]

    valueEnumstringobligatoire

    Valeurs possibles : [FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE]

    customLabelstring
    customValuestring
    _idstringobligatoire
    createdAtstring<date-time>obligatoire
    updatedAtstring<date-time>obligatoire
    Transit
    {
    "wallet": {
    "name": "string",
    "logo": "string",
    "icon": "string",
    "androidLogo": "string",
    "displayIdentifiant": true,
    "passBuilderPassTemplateId": "string",
    "passBuilderBusinessId": "string",
    "passBuilderToken": "string",
    "identifier": "string",
    "identifierQr": "string",
    "address": "string",
    "website": "string",
    "servicePhone": "string",
    "businessPhone": "string",
    "socialMedia": {
    "linkedin": "string",
    "facebook": "string",
    "instagram": "string",
    "tiktok": "string",
    "twitter": "string",
    "youtube": "string",
    "snapchat": "string",
    "pinterest": "string",
    "reddit": "string",
    "whatsapp": "string",
    "telegram": "string"
    },
    "additionalContacts": [
    {
    "title": "string",
    "value": "string",
    "kind": "URL"
    }
    ],
    "termsAndConditions": {
    "type": "PDF",
    "customUrl": "string",
    "pdfUrl": "string"
    },
    "webHookUrl": "string",
    "rootDomain": "string",
    "timezone": "string",
    "allowedPasses": [
    "ALL"
    ],
    "expiredCleanupEnabled": true,
    "_id": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    },
    "barcodeFormat": "AZTEC",
    "terms": "string",
    "emailSubscriptionMessage": "string",
    "subscriptionMessage": "string",
    "locations": [
    {
    "longitude": 0,
    "latitude": 0,
    "relevantName": "string",
    "relevantAddress": "string"
    }
    ],
    "colors": {
    "labelColor": "string",
    "backgroundColor": "string",
    "foregroundColor": "string"
    },
    "strip": "string",
    "customerServiceNumber": "string",
    "originStationCode": "string",
    "originName": "string",
    "destinationStationCode": "string",
    "destinationName": "string",
    "departureTime": "string",
    "arrivalTime": "string",
    "tarif": "string",
    "details": "string",
    "number": "string",
    "type": "Bus",
    "gateName": "N_CABINE",
    "seatName": "N_CABINE",
    "security": {
    "enableOneTimeUse": true,
    "disableIOSPassSharing": true,
    "disablePassLinkSharing": true,
    "disableMultipleHolders": true,
    "enableSecurityAnimation": true,
    "enableRotatingBarcode": true
    },
    "passBuilderPassTemplateId": "string",
    "customBackFields": [
    "string"
    ],
    "displayOptions": {
    "hideTarif": true,
    "hideStationCodes": true,
    "hideTripNumber": true
    },
    "iosHeader": {
    "labelEnum": "FULLNAME",
    "valueEnum": "FULLNAME",
    "customLabel": "string",
    "customValue": "string"
    },
    "_id": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }

    Les nouveautés de l'API, une fois par mois

    Nouveaux endpoints, changements à prévoir, guides et cas d'usage. Pas de spam, désinscription en un clic.

    Signaler un problème technique

    Une erreur de l’API, un pass qui ne se met pas à jour, un e-mail qui n’arrive pas ? Décrivez le problème : notre équipe technique vous répond.

    Pour une réponse rapide, indiquez :

    • La méthode et l’endpoint (ex. POST /clients)
    • Le code d’erreur renvoyé (errorCode) et le corps envoyé
    • La date et l’heure de l’appel
    • Les identifiants concernés (client, modèle, pass)

    N’y mettez jamais de jeton d’API ni de mot de passe.

    Assistant IA

    Beta

    Chargement…

    Réponses générées par IA (Claude) : vérifiez les points importants.

    Connectez-vous pour utiliser l'assistant