Boldest Developer Documentation

The purpose of this documentation is to provide all the information required for integrating Boldest widget into any other environment.

The contents are divided into two groups: On the one hand, a set of instructions for integrating Boldest widget into third-party websites and interact with it. On the other hand, the REST API, which allows pushing and pulling content and configurations to/from the Boldest platform.

Widget integration for web

• Embedding a Boldest map
  • Attributes
    • General Configuration
    • URL Configuration
    • Map Configuration
    • Events
    • Height Configuration
  • Embed examples
    • Segment integration
    • Full-screen / sticky integration
    • Modal window integration
  • React map embed library
    • Install boldest-lib library
    • Use on React app∫
  • Example for SSR (server side rendering) with angular
• Embeding boldest landing
• Interacting via JavaScript
  • Widget ready event
  • Passing filters to the map widget from your environment
  • Getting filter values from the widget when they change

RestFull API

• Authentication
  • Auth API: /api/bw/v2/auth
    • Methods
      • POST: Generate a JWT using username and password
      • GET: Return authentication status
• Resources
  • Resource API: /api/bw/v2/resource
  • Methods
    • POST: Create/Update Resource
    • GET: Get Resource/s
    • DELETE: Delete Resource/s
    • POST: Request the Create/Update of a Resource group in a batch process
    • GET: Query the status of a batch process
    • POST/GET: Clone a Resource. Optionally can be added to a Map
    • GET: Get Schema JSON from the data structure of a Resource
    • GET: Get Schema JSON schema of a group of Resources in a batch process
  • Resource schema documentation
    • Properties:
      • id (required) Type: string. Size: (3, 80)
      • published Type: boolean
      • timeLastUpdate Type: string. Size: 19
      • title Type: string. Size: (0, 100)
      • shortDescription Type: string (nullable). Size: (0, 160)
      • htmlDescription Type: string (nullable). Size: (0, 1000)
      • htmlContent Type: string (nullable). Size: (0, 32000)
      • image Type: uri (nullable)
      • multimedia Type: array(Type: uri) (nullable)
      • multimediaTitle Type: string. Size: (0, 100)
      • urlAlias Type: string. Size: (2, 500)
      • canonicalUrl Type: uri (nullable). Size: (0, 500)
      • externalUrl Type: uri (nullable). Size: (0, 500)
      • externalUrlLabel Type: string (nullable). Size: (0, 250)
      • redirectLoadTo Type: string (nullable)
      • locationLat Type: number (nullable). Size: (-90, 90)
      • locationLon Type: number (nullable). Size: (-180, 180)
      • locationZoom Type: integer (nullable). Size: (2, 25)
      • mapIds Type: array(Type: string) (nullable)
      • mapIdsAdd Type: array(Type: string) (nullable)
      • mapSecondaryIds Type: array(Type: string) (nullable)
      • mapSecondaryIdsAdd Type: array(Type: string) (nullable)
      • poiResourceIds Type: array(Type: string) (nullable)
      • poiResourceIdsAdd Type: array(Type: string) (nullable)
      • hideInList Type: boolean. Default: False
      • resourceType Type: string
      • resourceCategories Type: array(Type: string) (nullable)
      • resourceRegions Type: array(Type: string) (nullable)
      • resourceStage Type: array(Type: string) (nullable)
      • resourceMapLayerType Type: string
      • mapLayerFile Type: uri (nullable)
      • contactAddress Type: string (nullable). Size: (0, 200)
      • contactCity Type: string (nullable). Size: (0, 60)
      • contactPostalCode Type: string (nullable). Size: (0, 8)
      • contactProvince Type: string (nullable). Size: (0, 60)
      • contactPhone Type: string (nullable). Size: (0, 40)
      • contactEmail Type: email (nullable). Size: (0, 255)
      • contactUrl Type: uri (nullable). Size: (0, 2000)
      • openingTimes Type: string (nullable). Size: (0, 2000)
      • ctaOnMap Type: boolean (nullable)
      • ctaOnImage Type: boolean (nullable)
      • ctaUrl Type: uri (nullable). Size: (0, 2000)
      • ctaLabel Type: string (nullable). Size: (0, 20)
      • ctaValuePrefix Type: string (nullable). Size: (0, 20)
      • ctaValue Type: string (nullable). Size: (0, 20)
      • ctaValueSufix Type: string (nullable). Size: (0, 20)
      • trackCircular Type: boolean (nullable)
      • trackEffortDataShow Type: boolean (nullable)
      • trackAltitudeShow Type: boolean (nullable)
      • trackHoverShow Type: boolean (nullable)
      • trackDurationMinutes Type: integer (nullable). Size: (1, *)
      • trackTravelDistance Type: integer (nullable). Size: (1, *)
      • trackSlopeUp Type: integer (nullable). Size: (0, *)
      • trackSlopeDown Type: integer (nullable). Size: (0, *)
      • trackDifficulty Type: integer (nullable). Enum: [None, 1, 2, 3, 4, 5]
      • trackStart Type: string (nullable). Size: (0, 100)
      • trackEnd Type: string (nullable). Size: (0, 100)
      • trackFile Type: uri (nullable)
    • Language information
• Maps
  • Map API: /api/bw/v2/map
  • Methods
    • POST: Create/Update Map
    • GET: Get Map/s
    • DELETE: Delete Map/s
    • POST: Request the Create/Update of a Map group in a batch process
    • GET: Query the status of a batch process
    • POST/GET: Clone a Map. Optionally can be added to a Map
    • GET: Get Schema JSON from the data structure of a Map
    • GET: Get Schema JSON schema of a group of Maps in a batch process
  • Map schema documentation
    • Properties:
      • id (required) Type: string. Size: (3, 80)
      • published Type: boolean
      • timeLastUpdate Type: string. Size: 19
      • title Type: string. Size: (0, 100)
      • shortDescription Type: string (nullable). Size: (0, 160)
      • image Type: uri (nullable)
      • urlAlias Type: string. Size: (2, 500)
      • canonicalUrl Type: uri (nullable). Size: (0, 500)
      • locationLat Type: number (nullable). Size: (-90, 90)
      • locationLon Type: number (nullable). Size: (-180, 180)
      • locationZoom Type: integer (nullable). Size: (2, 25)
      • mapLayerFile Type: uri (nullable)
      • ctaOnMap Type: boolean (nullable)
      • ctaOnImage Type: boolean (nullable)
      • ctaUrl Type: uri (nullable). Size: (0, 1500)
      • ctaLabel Type: string (nullable). Size: (0, 20)
      • ctaValuePrefix Type: string (nullable). Size: (0, 20)
      • ctaValue Type: string (nullable). Size: (0, 20)
      • ctaValueSufix Type: string (nullable). Size: (0, 20)
      • resourceIds Type: array(Type: string) (nullable)
      • resourceIdsAdd Type: array(Type: string) (nullable)
      • tourMultiday Type: array(Type: object)
      • secondaryResourceIds Type: array(Type: string) (nullable)
      • secondaryResourceIdsAdd Type: array(Type: string) (nullable)
      • poiResourceIds Type: array(Type: string) (nullable)
      • poiResourceIdsAdd Type: array(Type: string) (nullable)
      • brandedPoiIds Type: array(Type: string) (nullable)
      • trackResourceId Type: string (nullable)
      • routePlannerAuto Type: boolean
      • routePlannerMethod Type: string
      • routePlannerColor Type: string
      • routePlannerWidth Type: number. Size: (1, 4)
      • mapClusterize Type: boolean (nullable)
      • mapLabel Type: string (nullable). Size: (0, 40)
      • customFilterFile Type: uri (nullable)
      • customHeaderFile Type: uri (nullable)
      • customBrandedPoiFile Type: uri (nullable)
      • customLoaderFile Type: uri (nullable)
      • mapLayerType Type: string
      • mapMaxAutozoom Type: integer (nullable). Size: (2, 25)
      • mapIsTour Type: boolean (nullable)
      • trackResourceShowEffort Type: boolean (nullable)
      • mapShowFilter Type: boolean (nullable)
      • mapFilterType Type: string
      • mapFilterCategorySwitch Type: boolean (nullable)
      • mapFilterDifficultySwitch Type: boolean (nullable)
      • mapFilterDistanceSwitch Type: boolean (nullable)
      • mapFilterCircularSwitch Type: boolean (nullable)
      • mapFilterCategories Type: array(Type: string) (nullable)
      • mapShowList Type: boolean (nullable)
    • Schema tourMultiday item
      • dayLabels Type: array(Type: string)
      • title Type: string (nullable). Size: (0, 100)
      • shortDescription Type: string (nullable). Size: (0, 160)
      • htmlContent Type: string (nullable). Size: (0, 32000)
      • image Type: uri (nullable)
      • resourceIds Type: array(Type: string) (nullable)
    • Language information
• Landings
  • Landing API: /api/bw/v2/landing
  • Methods
    • POST: Create/Update Landing
    • GET: Get Landing/s
    • DELETE: Delete Landing/s
    • POST/GET: Clone a Landing. Optionally can be added to a Map
    • GET: Get Schema JSON from the data structure of a Landing
    • GET: Get Schema JSON schema of a group of Landings in a batch process
  • Landing schema documentation
    • Properties:
      • id (required) Type: string. Size: (3, 80)
      • published Type: boolean
      • timeLastUpdate Type: string. Size: 19
      • title Type: string. Size: (0, 100)
      • shortDescription Type: string (nullable). Size: (0, 160)
      • htmlDescription Type: string (nullable). Size: (0, 1000)
      • htmlContent Type: string (nullable). Size: (0, 32000)
      • image Type: uri (nullable)
      • urlAlias Type: string. Size: (2, 500)
      • canonicalUrl Type: uri (nullable). Size: (0, 500)
      • alternativeView Type: string (nullable)
      • proposal Type: boolean
      • proposalSummary Type: string (nullable). Size: (0, 2000)
      • proposalCalendar Type: string (nullable). Size: (0, 2000)
      • proposalDescription Type: string (nullable). Size: (0, 2000)
      • landingBlocks Type: array(Type: object)
      • landingHotels Type: array(Type: object)
      • buttonViewMapLabel Type: string (nullable). Size: (0, 200)
      • mapIntro Type: string (nullable). Size: (0, 250)
      • mapId Type: string
      • ctaOnMap Type: boolean (nullable)
      • ctaUrl Type: uri (nullable). Size: (0, 2000)
      • ctaLabel Type: string (nullable). Size: (0, 20)
      • ctaValuePrefix Type: string (nullable). Size: (0, 20)
      • ctaValue Type: string (nullable). Size: (0, 20)
      • ctaValueSufix Type: string (nullable). Size: (0, 20)
    • Schema landingBlocks item
      • title Type: string. Size: (0, 200)
      • shortDescription Type: string (nullable). Size: (0, 200)
      • htmlContent Type: string (nullable). Size: (0, 32000)
      • resourceIds Type: array(Type: string) (nullable)
    • Schema landingHotels item
      • title Type: string. Size: (0, 200)
      • shortDescription Type: string (nullable). Size: (0, 200)
      • htmlContent Type: string (nullable). Size: (0, 32000)
      • resourceIds Type: array(Type: string) (nullable)
    • Language information
• Proposals
  • Proposal API: /api/bw/v2/proposal
  • Methods
    • POST: Create/Update Proposal
    • GET: Get Proposal/s
    • DELETE: Delete Proposal/s
    • POST/GET: Clone a Proposal. Optionally can be added to a Map
    • GET: Get Schema JSON from the data structure of a Proposal
    • GET: Get Schema JSON schema of a group of Proposals in a batch process
  • Proposal schema documentation
    • Properties:
      • id (required) Type: string. Size: (3, 80)
      • published Type: boolean
      • timeLastUpdate Type: string. Size: 19
      • title Type: string. Size: (0, 100)
      • shortDescription Type: string (nullable). Size: (0, 160)
      • htmlDescription Type: string (nullable). Size: (0, 1000)
      • htmlContent Type: string (nullable). Size: (0, 32000)
      • image Type: uri (nullable)
      • urlAlias Type: string. Size: (2, 500)
      • canonicalUrl Type: uri (nullable). Size: (0, 500)
      • infoSummary Type: string (nullable). Size: (0, 2000)
      • relatedContents Type: array(Type: object)
      • hotels Type: array(Type: object)
      • buttonViewMapLabel Type: string (nullable). Size: (0, 200)
      • mapId Type: string
      • ctaUrl Type: uri (nullable). Size: (0, 2000)
      • ctaLabel Type: string (nullable). Size: (0, 20)
      • ctaValuePrefix Type: string (nullable). Size: (0, 20)
      • ctaValue Type: string (nullable). Size: (0, 20)
      • ctaValueSufix Type: string (nullable). Size: (0, 20)
      • customerId Type: string (nullable). Size: (3, 80)
      • groupName Type: string (nullable). Size: (0, 100)
      • tripDates Type: string (nullable). Size: (0, 100)
      • paxNum Type: string (nullable). Size: (0, 100)
      • roomsNum Type: string (nullable). Size: (0, 100)
      • pricing Type: string (nullable). Size: (0, 1000)
      • expireDate Type: string (nullable). Size: 10
      • typeSchema Type: string
      • statsAccess Type: integer
      • statsLastAccess Type: string. Size: 19
    • Schema relatedContents item
      • title Type: string. Size: (0, 200)
      • shortDescription Type: string (nullable). Size: (0, 200)
      • htmlContent Type: string (nullable). Size: (0, 32000)
    • Schema hotels item
      • title Type: string. Size: (0, 200)
      • shortDescription Type: string (nullable). Size: (0, 200)
      • htmlContent Type: string (nullable). Size: (0, 32000)
      • resourceIds Type: array(Type: string) (nullable)
    • Language information
• Categories
  • Category API: /api/bw/v2/category
  • Methods
    • POST: Create/Update Category
    • GET: Get Category/s
    • DELETE: Delete Category/s
    • GET: Get Schema JSON from the data structure of a Category
    • GET: Get Schema JSON schema of a group of Categories in a batch process
  • Category schema documentation
    • Properties:
      • id (required) Type: string. Size: (3, 80)
      • title Type: string. Size: (0, 100)
      • shortDescription Type: string (nullable). Size: (0, 160)
      • image Type: uri. Size: (0, 1500)
    • Language information