Skip to content
Bao Ha Digital Culture/Data-sharing information portal

INTEGRATION DOCUMENTATION

Data-sharing API catalogue

Explore the application programming interfaces available for connecting to, accessing and sharing data from the Bao Ha Digital Culture platform.

Explore APIs

Reviewed on: •Catalogue version 1.0

104

Published APIs

13

Business domains

88

Data retrieval APIs

16

Submission & processing APIs

Publication scope

APIs available for public access, covering data retrieval, registration, interaction and account authentication. Some require a private lookup or registration code, as noted individually. Administration, signed-in account APIs and separately authenticated integrations are outside this catalogue.

01 / API CATALOGUE

API catalogue

Showing 104 of 104 APIs

01

Heritage sites & areas9 API

Heritage records, classifications, areas and introductions.

GETList heritage sites/api/relics

Usage details

https://api.denbaoha.vn/api/relics
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPaginated heritage categories/api/relics/category

Usage details

https://api.denbaoha.vn/api/relics/category
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETHeritage filters/api/relics/filter

Usage details

https://api.denbaoha.vn/api/relics/filter
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETFeatured heritage site/api/relics/featured-detail

Usage details

https://api.denbaoha.vn/api/relics/featured-detail
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETHeritage site details/api/relics/detail/{id}

Usage details

https://api.denbaoha.vn/api/relics/detail/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETHeritage categories/api/relic-categories

Usage details

https://api.denbaoha.vn/api/relic-categories
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETAreas within a heritage site/api/relics/{relic}/areas

Usage details

https://api.denbaoha.vn/api/relics/{relic}/areas
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relic

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETHeritage area details/api/relics/{relic}/areas/{area}

Usage details

https://api.denbaoha.vn/api/relics/{relic}/areas/{area}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relicarea

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETLook up a heritage area/api/relic-areas/detail/{area}

Usage details

https://api.denbaoha.vn/api/relic-areas/detail/{area}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
area

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

02

360° spaces & maps10 API

Virtual tours, worship spaces, digital models and temple maps.

GETList 360° tours/api/relics/{relic}/360-tours

Usage details

https://api.denbaoha.vn/api/relics/{relic}/360-tours
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relic

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GET360° tour details/api/relics/{relic}/360-tours/{tour}

Usage details

https://api.denbaoha.vn/api/relics/{relic}/360-tours/{tour}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relictour

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETTemple map for a heritage site/api/relics/{relic}/temple-map

Usage details

https://api.denbaoha.vn/api/relics/{relic}/temple-map
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relic

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETList worship spaces/api/le-bai/spaces

Usage details

https://api.denbaoha.vn/api/le-bai/spaces
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETWorship space details/api/le-bai/spaces/{slug}

Usage details

https://api.denbaoha.vn/api/le-bai/spaces/{slug}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
slug

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETList worship models/api/le-bai/models

Usage details

https://api.denbaoha.vn/api/le-bai/models
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETAI assistant model/api/le-bai/models/ai-home-bot

Usage details

https://api.denbaoha.vn/api/le-bai/models/ai-home-bot
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETHeritage sites with worship spaces/api/le-bai/relics

Usage details

https://api.denbaoha.vn/api/le-bai/relics
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETWorship space by heritage site/api/le-bai/relics/{relicSlug}/spaces/{spaceSlug}

Usage details

https://api.denbaoha.vn/api/le-bai/relics/{relicSlug}/spaces/{spaceSlug}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relicSlugspaceSlug

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETWorship space by heritage area/api/le-bai/relics/{relicSlug}/areas/{areaSlug}/spaces/{spaceSlug}

Usage details

https://api.denbaoha.vn/api/le-bai/relics/{relicSlug}/areas/{areaSlug}/spaces/{spaceSlug}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relicSlugareaSlugspaceSlug

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

03

Artifacts6 API

Categories, filters and artifact records.

GETList artifacts/api/artifacts

Usage details

https://api.denbaoha.vn/api/artifacts
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPaginated artifact categories/api/artifacts/category

Usage details

https://api.denbaoha.vn/api/artifacts/category
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETArtifact categories/api/artifact-categories

Usage details

https://api.denbaoha.vn/api/artifact-categories
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETArtifact filters/api/artifacts/filter

Usage details

https://api.denbaoha.vn/api/artifacts/filter
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETArtifact details/api/artifacts/detail/{id}

Usage details

https://api.denbaoha.vn/api/artifacts/detail/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETArtifact details (short path)/api/artifacts/{id}

Usage details

https://api.denbaoha.vn/api/artifacts/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

04

Culture & research7 API

Mother Goddess cultural articles and scientific documents.

GETList cultural articles/api/articles

Usage details

https://api.denbaoha.vn/api/articles
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETCultural article categories/api/articles/category

Usage details

https://api.denbaoha.vn/api/articles/category
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETCultural article filters/api/articles/filter

Usage details

https://api.denbaoha.vn/api/articles/filter
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETCultural article details/api/articles/detail/{id}

Usage details

https://api.denbaoha.vn/api/articles/detail/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETList scientific documents/api/science-docs

Usage details

https://api.denbaoha.vn/api/science-docs
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETScientific document categories/api/science-docs/category

Usage details

https://api.denbaoha.vn/api/science-docs/category
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETScientific document details/api/science-docs/detail/{id}

Usage details

https://api.denbaoha.vn/api/science-docs/detail/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

05

News & events12 API

News, events and their content categories.

GETList news/api/news

Usage details

https://api.denbaoha.vn/api/news
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPaginated news/api/news/list

Usage details

https://api.denbaoha.vn/api/news/list
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETNews filters/api/news/filters

Usage details

https://api.denbaoha.vn/api/news/filters
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETNews details/api/news/{news}

Usage details

https://api.denbaoha.vn/api/news/{news}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
news

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETNews categories/api/news-categories

Usage details

https://api.denbaoha.vn/api/news-categories
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETNews category details/api/news-categories/{news_category}

Usage details

https://api.denbaoha.vn/api/news-categories/{news_category}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
news_category

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETList events/api/events

Usage details

https://api.denbaoha.vn/api/events
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPaginated events/api/events/list

Usage details

https://api.denbaoha.vn/api/events/list
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETEvent filters/api/events/filters

Usage details

https://api.denbaoha.vn/api/events/filters
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETEvent details/api/events/{event}

Usage details

https://api.denbaoha.vn/api/events/{event}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
event

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETEvent categories/api/event-categories

Usage details

https://api.denbaoha.vn/api/event-categories
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETEvent category details/api/event-categories/{event_category}

Usage details

https://api.denbaoha.vn/api/event-categories/{event_category}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
event_category

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

06

Images & audio6 API

Image library, image uploads and text-to-speech services.

GETImage library/api/library-images

Usage details

https://api.denbaoha.vn/api/library-images
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETFiltered image list/api/library-images/list

Usage details

https://api.denbaoha.vn/api/library-images/list
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETImage details/api/library-images/{library_image}

Usage details

https://api.denbaoha.vn/api/library-images/{library_image}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
library_image

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

POSTUpload an image/api/upload-image

Usage details

https://api.denbaoha.vn/api/upload-image
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send multipart/form-data with the upload file field.

POSTSynthesize speech from text/api/tts/vbee

Usage details

https://api.denbaoha.vn/api/tts/vbee
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Body: text (required, up to 5,000 characters), voice_code, speed_rate (0.1–1.9). Limited to 20 requests/minute; may return HTTP 202 while processing.

GETSpeech synthesis status/api/tts/vbee/{requestId}

Usage details

https://api.denbaoha.vn/api/tts/vbee/{requestId}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
requestId

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Use the requestId returned by the speech service. Limited to 60 requests/minute; HTTP 202 indicates processing.

07

Services & shops15 API

Local services, shops, products and ritual masters.

GETList local services/api/local-services

Usage details

https://api.denbaoha.vn/api/local-services
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETLocal service categories/api/local-services/categories

Usage details

https://api.denbaoha.vn/api/local-services/categories
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETService categories (alias)/api/local-services/category

Usage details

https://api.denbaoha.vn/api/local-services/category
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETLocal service filters/api/local-services/filter

Usage details

https://api.denbaoha.vn/api/local-services/filter
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETLocal service details/api/local-services/detail/{id}

Usage details

https://api.denbaoha.vn/api/local-services/detail/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETService details (short path)/api/local-services/{id}

Usage details

https://api.denbaoha.vn/api/local-services/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

POSTRegister a local service/api/local-services/registrations

Usage details

https://api.denbaoha.vn/api/local-services/registrations
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Submit the required business data using POST. Requests may create records or initiate processing; this catalogue provides information and does not execute operations.

POSTLook up a service registration/api/local-services/registrations/lookupLookup / registration code

Usage details

https://api.denbaoha.vn/api/local-services/registrations/lookup
Suggested headers
Accept: application/json
lang: en
Access conditions

Lookup / registration code

Send code and contact (the email or phone matching the registration) in the body.

GETList shops/api/shops

Usage details

https://api.denbaoha.vn/api/shops
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETShop details/api/shops/{shop}

Usage details

https://api.denbaoha.vn/api/shops/{shop}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
shop

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETShop products/api/shops/{shop}/products

Usage details

https://api.denbaoha.vn/api/shops/{shop}/products
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
shop

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETShop reviews/api/shops/{shop}/reviews

Usage details

https://api.denbaoha.vn/api/shops/{shop}/reviews
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
shop

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETShop payment methods/api/shops/{shop}/payment-methods

Usage details

https://api.denbaoha.vn/api/shops/{shop}/payment-methods
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
shop

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETProduct and ritual offering categories/api/product-categories

Usage details

https://api.denbaoha.vn/api/product-categories
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETList ritual masters/api/ritual-masters

Usage details

https://api.denbaoha.vn/api/ritual-masters
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

08

Ceremonies & donations9 API

Ceremony areas, registrations and donation services.

GETList ceremony areas/api/relics/{relic}/cung-hau-areas

Usage details

https://api.denbaoha.vn/api/relics/{relic}/cung-hau-areas
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relic

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETCeremony area details/api/relics/{relic}/cung-hau-areas/{area}

Usage details

https://api.denbaoha.vn/api/relics/{relic}/cung-hau-areas/{area}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relicarea

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETCheck ceremony availability/api/relics/{relic}/cung-hau-areas/{area}/availability

Usage details

https://api.denbaoha.vn/api/relics/{relic}/cung-hau-areas/{area}/availability
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relicarea

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Requires a date query in YYYY-MM-DD format. Optional: hau_start_time (HH:mm), start_time or relic_area_id.

GETConfirmed ceremony schedule/api/relics/{relic}/cung-hau-areas/{area}/registrations

Usage details

https://api.denbaoha.vn/api/relics/{relic}/cung-hau-areas/{area}/registrations
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relicarea

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

POSTSubmit a ceremony registration/api/relics/{relic}/cung-hau-areas/{area}/registrations

Usage details

https://api.denbaoha.vn/api/relics/{relic}/cung-hau-areas/{area}/registrations
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
relicarea

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Submit the required business data using POST. Requests may create records or initiate processing; this catalogue provides information and does not execute operations.

GETPublic donation list/api/donations

Usage details

https://api.denbaoha.vn/api/donations
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

POSTSubmit a donation/api/donations

Usage details

https://api.denbaoha.vn/api/donations
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Submit the required business data using POST. Requests may create records or initiate processing; this catalogue provides information and does not execute operations.

GETDonation payment capabilities/api/donations/payment-capabilities

Usage details

https://api.denbaoha.vn/api/donations/payment-capabilities
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETDonation payment status/api/donations/{donation}/payment-statusLookup / registration code

Usage details

https://api.denbaoha.vn/api/donations/{donation}/payment-status
Suggested headers
Accept: application/json
lang: en
Access conditions

Lookup / registration code

Path parameters
donation

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Requires the valid query token issued for the corresponding donation.

09

Community & pilgrimage8 API

Pilgrimage journals, comments, feedback and conversational assistance.

GETPublic pilgrimage journals/api/pilgrimage-journals

Usage details

https://api.denbaoha.vn/api/pilgrimage-journals
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPilgrimage journal filters/api/pilgrimage-journals/filter

Usage details

https://api.denbaoha.vn/api/pilgrimage-journals/filter
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPilgrimage journal details/api/pilgrimage-journals/{id}

Usage details

https://api.denbaoha.vn/api/pilgrimage-journals/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPilgrimage journal comments/api/pilgrimage-journals/{journal}/comments

Usage details

https://api.denbaoha.vn/api/pilgrimage-journals/{journal}/comments
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
journal

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

POSTRecord a journal share/api/pilgrimage-journals/{journal}/share

Usage details

https://api.denbaoha.vn/api/pilgrimage-journals/{journal}/share
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
journal

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Submit the required business data using POST. Requests may create records or initiate processing; this catalogue provides information and does not execute operations.

GETList comments/api/comments

Usage details

https://api.denbaoha.vn/api/comments
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

POSTSubmit feedback/api/reflacts

Usage details

https://api.denbaoha.vn/api/reflacts
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Submit the required business data using POST. Requests may create records or initiate processing; this catalogue provides information and does not execute operations.

POSTMessage the conversational assistant/api/chat/messages

Usage details

https://api.denbaoha.vn/api/chat/messages
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Supports guest access; account-specific actions may require sign-in. This API selects language using the locale body field (vi or en), defaulting to vi; the lang header does not replace this field.

10

Reference data5 API

Administrative divisions, positions and shared filters.

GETList provinces and cities/api/provinces

Usage details

https://api.denbaoha.vn/api/provinces
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETList wards and communes/api/wards

Usage details

https://api.denbaoha.vn/api/wards
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETWards by province/api/wards-by-province

Usage details

https://api.denbaoha.vn/api/wards-by-province
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETGovernment positions/api/government/positions

Usage details

https://api.denbaoha.vn/api/government/positions
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETShared filters/api/filters

Usage details

https://api.denbaoha.vn/api/filters
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

11

Information & support10 API

Site information, guides, FAQs and public statistics.

GETSite and contact information/api/site-info

Usage details

https://api.denbaoha.vn/api/site-info
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETList banners/api/banners

Usage details

https://api.denbaoha.vn/api/banners
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETStatic content by key/api/template-statics/{key}

Usage details

https://api.denbaoha.vn/api/template-statics/{key}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
key

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETUser manuals/api/user-manuals

Usage details

https://api.denbaoha.vn/api/user-manuals
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETList frequently asked questions/api/faqs

Usage details

https://api.denbaoha.vn/api/faqs
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPaginated FAQ categories/api/faqs/category

Usage details

https://api.denbaoha.vn/api/faqs/category
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETFAQ categories/api/faqs/categories

Usage details

https://api.denbaoha.vn/api/faqs/categories
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETFAQ filters/api/faqs/filter

Usage details

https://api.denbaoha.vn/api/faqs/filter
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETFAQ details/api/faqs/detail/{id}

Usage details

https://api.denbaoha.vn/api/faqs/detail/{id}
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Path parameters
id

Replace values in braces with the corresponding record identifier. Parameters named slug or ending in Slug use the content slug.

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

GETPublic application traffic summary/api/public-reports/app-traffic-summary

Usage details

https://api.denbaoha.vn/api/public-reports/app-traffic-summary
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Send a GET request to retrieve data. Pagination and filters depend on the endpoint; response structures may differ between business domains.

12

Registration & authentication5 API

Sign-in and registration endpoints available before authentication.

POSTSign in/api/auth/login

Usage details

https://api.denbaoha.vn/api/auth/login
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Submit the required business data using POST. Requests may create records or initiate processing; this catalogue provides information and does not execute operations.

POSTRegister a user account/api/auth/register

Usage details

https://api.denbaoha.vn/api/auth/register
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Submit the required business data using POST. Requests may create records or initiate processing; this catalogue provides information and does not execute operations.

POSTRequest password recovery/api/auth/forget-password

Usage details

https://api.denbaoha.vn/api/auth/forget-password
Suggested headers
Accept: application/json
lang: en
Access conditions

No sign-in required

Submit the required business data using POST. Requests may create records or initiate processing; this catalogue provides information and does not execute operations.

POSTVerify a government registration code/api/auth/verify-government-codeLookup / registration code

Usage details

https://api.denbaoha.vn/api/auth/verify-government-code
Suggested headers
Accept: application/json
lang: en
Access conditions

Lookup / registration code

Requires an issued government registration code (code).

POSTRegister a government account/api/auth/register-governmentLookup / registration code

Usage details

https://api.denbaoha.vn/api/auth/register-government
Suggested headers
Accept: application/json
lang: en
Access conditions

Lookup / registration code

Requires a valid government_code and the registration information required by the system.

13

Event integrations2 API

Callback and event receivers for integrated services.

POSTSpeech service callback/api/tts/vbee/callbackService callback

Usage details

https://api.denbaoha.vn/api/tts/vbee/callback
Suggested headers
Accept: application/json
lang: en
Access conditions

Service callback

Callback receiver for the speech provider; not a data query endpoint.

POSTReceive AI Box events/api/webhooks/aiboxService callback

Usage details

https://api.denbaoha.vn/api/webhooks/aibox
Suggested headers
Accept: application/json
lang: en
Access conditions

Service callback

Receives JSON events from AI Box and may create alerts or record visitor counts. This is an event receiver, not a data query API.

Complete reference catalogue

Each API is counted by its HTTP method and path. Equivalent paths are listed separately; HEAD is not counted in addition to GET.

Heritage sites & areas

MethodAPI name / EndpointAccess conditions
GETList heritage sites/api/relicsNo sign-in required
GETPaginated heritage categories/api/relics/categoryNo sign-in required
GETHeritage filters/api/relics/filterNo sign-in required
GETFeatured heritage site/api/relics/featured-detailNo sign-in required
GETHeritage site details/api/relics/detail/{id}No sign-in required
GETHeritage categories/api/relic-categoriesNo sign-in required
GETAreas within a heritage site/api/relics/{relic}/areasNo sign-in required
GETHeritage area details/api/relics/{relic}/areas/{area}No sign-in required
GETLook up a heritage area/api/relic-areas/detail/{area}No sign-in required

360° spaces & maps

MethodAPI name / EndpointAccess conditions
GETList 360° tours/api/relics/{relic}/360-toursNo sign-in required
GET360° tour details/api/relics/{relic}/360-tours/{tour}No sign-in required
GETTemple map for a heritage site/api/relics/{relic}/temple-mapNo sign-in required
GETList worship spaces/api/le-bai/spacesNo sign-in required
GETWorship space details/api/le-bai/spaces/{slug}No sign-in required
GETList worship models/api/le-bai/modelsNo sign-in required
GETAI assistant model/api/le-bai/models/ai-home-botNo sign-in required
GETHeritage sites with worship spaces/api/le-bai/relicsNo sign-in required
GETWorship space by heritage site/api/le-bai/relics/{relicSlug}/spaces/{spaceSlug}No sign-in required
GETWorship space by heritage area/api/le-bai/relics/{relicSlug}/areas/{areaSlug}/spaces/{spaceSlug}No sign-in required

Artifacts

MethodAPI name / EndpointAccess conditions
GETList artifacts/api/artifactsNo sign-in required
GETPaginated artifact categories/api/artifacts/categoryNo sign-in required
GETArtifact categories/api/artifact-categoriesNo sign-in required
GETArtifact filters/api/artifacts/filterNo sign-in required
GETArtifact details/api/artifacts/detail/{id}No sign-in required
GETArtifact details (short path)/api/artifacts/{id}No sign-in required

Culture & research

MethodAPI name / EndpointAccess conditions
GETList cultural articles/api/articlesNo sign-in required
GETCultural article categories/api/articles/categoryNo sign-in required
GETCultural article filters/api/articles/filterNo sign-in required
GETCultural article details/api/articles/detail/{id}No sign-in required
GETList scientific documents/api/science-docsNo sign-in required
GETScientific document categories/api/science-docs/categoryNo sign-in required
GETScientific document details/api/science-docs/detail/{id}No sign-in required

News & events

MethodAPI name / EndpointAccess conditions
GETList news/api/newsNo sign-in required
GETPaginated news/api/news/listNo sign-in required
GETNews filters/api/news/filtersNo sign-in required
GETNews details/api/news/{news}No sign-in required
GETNews categories/api/news-categoriesNo sign-in required
GETNews category details/api/news-categories/{news_category}No sign-in required
GETList events/api/eventsNo sign-in required
GETPaginated events/api/events/listNo sign-in required
GETEvent filters/api/events/filtersNo sign-in required
GETEvent details/api/events/{event}No sign-in required
GETEvent categories/api/event-categoriesNo sign-in required
GETEvent category details/api/event-categories/{event_category}No sign-in required

Images & audio

MethodAPI name / EndpointAccess conditions
GETImage library/api/library-imagesNo sign-in required
GETFiltered image list/api/library-images/listNo sign-in required
GETImage details/api/library-images/{library_image}No sign-in required
POSTUpload an image/api/upload-image

Send multipart/form-data with the upload file field.

No sign-in required
POSTSynthesize speech from text/api/tts/vbee

Body: text (required, up to 5,000 characters), voice_code, speed_rate (0.1–1.9). Limited to 20 requests/minute; may return HTTP 202 while processing.

No sign-in required
GETSpeech synthesis status/api/tts/vbee/{requestId}

Use the requestId returned by the speech service. Limited to 60 requests/minute; HTTP 202 indicates processing.

No sign-in required

Services & shops

MethodAPI name / EndpointAccess conditions
GETList local services/api/local-servicesNo sign-in required
GETLocal service categories/api/local-services/categoriesNo sign-in required
GETService categories (alias)/api/local-services/categoryNo sign-in required
GETLocal service filters/api/local-services/filterNo sign-in required
GETLocal service details/api/local-services/detail/{id}No sign-in required
GETService details (short path)/api/local-services/{id}No sign-in required
POSTRegister a local service/api/local-services/registrationsNo sign-in required
POSTLook up a service registration/api/local-services/registrations/lookup

Send code and contact (the email or phone matching the registration) in the body.

Lookup / registration code
GETList shops/api/shopsNo sign-in required
GETShop details/api/shops/{shop}No sign-in required
GETShop products/api/shops/{shop}/productsNo sign-in required
GETShop reviews/api/shops/{shop}/reviewsNo sign-in required
GETShop payment methods/api/shops/{shop}/payment-methodsNo sign-in required
GETProduct and ritual offering categories/api/product-categoriesNo sign-in required
GETList ritual masters/api/ritual-mastersNo sign-in required

Ceremonies & donations

MethodAPI name / EndpointAccess conditions
GETList ceremony areas/api/relics/{relic}/cung-hau-areasNo sign-in required
GETCeremony area details/api/relics/{relic}/cung-hau-areas/{area}No sign-in required
GETCheck ceremony availability/api/relics/{relic}/cung-hau-areas/{area}/availability

Requires a date query in YYYY-MM-DD format. Optional: hau_start_time (HH:mm), start_time or relic_area_id.

No sign-in required
GETConfirmed ceremony schedule/api/relics/{relic}/cung-hau-areas/{area}/registrationsNo sign-in required
POSTSubmit a ceremony registration/api/relics/{relic}/cung-hau-areas/{area}/registrationsNo sign-in required
GETPublic donation list/api/donationsNo sign-in required
POSTSubmit a donation/api/donationsNo sign-in required
GETDonation payment capabilities/api/donations/payment-capabilitiesNo sign-in required
GETDonation payment status/api/donations/{donation}/payment-status

Requires the valid query token issued for the corresponding donation.

Lookup / registration code

Community & pilgrimage

MethodAPI name / EndpointAccess conditions
GETPublic pilgrimage journals/api/pilgrimage-journalsNo sign-in required
GETPilgrimage journal filters/api/pilgrimage-journals/filterNo sign-in required
GETPilgrimage journal details/api/pilgrimage-journals/{id}No sign-in required
GETPilgrimage journal comments/api/pilgrimage-journals/{journal}/commentsNo sign-in required
POSTRecord a journal share/api/pilgrimage-journals/{journal}/shareNo sign-in required
GETList comments/api/commentsNo sign-in required
POSTSubmit feedback/api/reflactsNo sign-in required
POSTMessage the conversational assistant/api/chat/messages

Supports guest access; account-specific actions may require sign-in. This API selects language using the locale body field (vi or en), defaulting to vi; the lang header does not replace this field.

No sign-in required

Reference data

MethodAPI name / EndpointAccess conditions
GETList provinces and cities/api/provincesNo sign-in required
GETList wards and communes/api/wardsNo sign-in required
GETWards by province/api/wards-by-provinceNo sign-in required
GETGovernment positions/api/government/positionsNo sign-in required
GETShared filters/api/filtersNo sign-in required

Information & support

MethodAPI name / EndpointAccess conditions
GETSite and contact information/api/site-infoNo sign-in required
GETList banners/api/bannersNo sign-in required
GETStatic content by key/api/template-statics/{key}No sign-in required
GETUser manuals/api/user-manualsNo sign-in required
GETList frequently asked questions/api/faqsNo sign-in required
GETPaginated FAQ categories/api/faqs/categoryNo sign-in required
GETFAQ categories/api/faqs/categoriesNo sign-in required
GETFAQ filters/api/faqs/filterNo sign-in required
GETFAQ details/api/faqs/detail/{id}No sign-in required
GETPublic application traffic summary/api/public-reports/app-traffic-summaryNo sign-in required

Registration & authentication

MethodAPI name / EndpointAccess conditions
POSTSign in/api/auth/loginNo sign-in required
POSTRegister a user account/api/auth/registerNo sign-in required
POSTRequest password recovery/api/auth/forget-passwordNo sign-in required
POSTVerify a government registration code/api/auth/verify-government-code

Requires an issued government registration code (code).

Lookup / registration code
POSTRegister a government account/api/auth/register-government

Requires a valid government_code and the registration information required by the system.

Lookup / registration code

Event integrations

MethodAPI name / EndpointAccess conditions
POSTSpeech service callback/api/tts/vbee/callback

Callback receiver for the speech provider; not a data query endpoint.

Service callback
POSTReceive AI Box events/api/webhooks/aibox

Receives JSON events from AI Box and may create alerts or record visitor counts. This is an event receiver, not a data query API.

Service callback

02 / INTEGRATION GUIDE

Integration guide

Basic conventions for using the APIs and processing responses.

1

Select the relevant API

Identify the HTTP method, path and access conditions. The full address combines the API base URL with the corresponding endpoint path.

2

Select the content language

Send lang: vi or lang: en in the request headers. Content follows the requested language and available translations. For narrated content, use the audio URL returned by the API for that language.

3

Handle the response

Check the HTTP status and endpoint-specific fields (success, result, data, meta…). Do not assume every API shares the same pagination structure or filters.

Example: retrieve heritage sitescURL
curl --request GET \
  'https://api.denbaoha.vn/api/relics?per_page=10' \
  --header 'Accept: application/json' \
  --header 'lang: en'

A GET request that does not require account credentials.

Common response codes

200
Request completed successfully
201
Data created
202
Accepted and processing
403
Access conditions not met
404
Data not found
422
Invalid submitted data
429
Request rate limit exceeded

Each API is counted by its HTTP method and path. Equivalent paths are listed separately; HEAD is not counted in addition to GET.