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.
Reviewed on: •Catalogue version 1.0
Published APIs
Business domains
Data retrieval APIs
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
Heritage sites & areas9 API
Heritage records, classifications, areas and introductions.
GETList heritage sites/api/relics
Usage details
https://api.denbaoha.vn/api/relicsSuggested headers
Accept: application/json
lang: enAccess 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/categorySuggested headers
Accept: application/json
lang: enAccess 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/filterSuggested headers
Accept: application/json
lang: enAccess 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-detailSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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-categoriesSuggested headers
Accept: application/json
lang: enAccess 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}/areasSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
relicReplace 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: enAccess conditions
No sign-in required
Path parameters
relicareaReplace 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: enAccess conditions
No sign-in required
Path parameters
areaReplace 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.
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-toursSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
relicReplace 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: enAccess conditions
No sign-in required
Path parameters
relictourReplace 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-mapSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
relicReplace 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/spacesSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
slugReplace 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/modelsSuggested headers
Accept: application/json
lang: enAccess 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-botSuggested headers
Accept: application/json
lang: enAccess 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/relicsSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
relicSlugspaceSlugReplace 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: enAccess conditions
No sign-in required
Path parameters
relicSlugareaSlugspaceSlugReplace 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.
Artifacts6 API
Categories, filters and artifact records.
GETList artifacts/api/artifacts
Usage details
https://api.denbaoha.vn/api/artifactsSuggested headers
Accept: application/json
lang: enAccess 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/categorySuggested headers
Accept: application/json
lang: enAccess 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-categoriesSuggested headers
Accept: application/json
lang: enAccess 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/filterSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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.
Culture & research7 API
Mother Goddess cultural articles and scientific documents.
GETList cultural articles/api/articles
Usage details
https://api.denbaoha.vn/api/articlesSuggested headers
Accept: application/json
lang: enAccess 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/categorySuggested headers
Accept: application/json
lang: enAccess 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/filterSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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-docsSuggested headers
Accept: application/json
lang: enAccess 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/categorySuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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.
News & events12 API
News, events and their content categories.
GETList news/api/news
Usage details
https://api.denbaoha.vn/api/newsSuggested headers
Accept: application/json
lang: enAccess 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/listSuggested headers
Accept: application/json
lang: enAccess 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/filtersSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
newsReplace 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-categoriesSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
news_categoryReplace 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/eventsSuggested headers
Accept: application/json
lang: enAccess 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/listSuggested headers
Accept: application/json
lang: enAccess 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/filtersSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
eventReplace 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-categoriesSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
event_categoryReplace 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.
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-imagesSuggested headers
Accept: application/json
lang: enAccess 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/listSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
library_imageReplace 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-imageSuggested headers
Accept: application/json
lang: enAccess 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/vbeeSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
requestIdReplace 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.
Services & shops15 API
Local services, shops, products and ritual masters.
GETList local services/api/local-services
Usage details
https://api.denbaoha.vn/api/local-servicesSuggested headers
Accept: application/json
lang: enAccess 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/categoriesSuggested headers
Accept: application/json
lang: enAccess 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/categorySuggested headers
Accept: application/json
lang: enAccess 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/filterSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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/registrationsSuggested headers
Accept: application/json
lang: enAccess 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/lookupSuggested headers
Accept: application/json
lang: enAccess 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/shopsSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
shopReplace 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}/productsSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
shopReplace 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}/reviewsSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
shopReplace 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-methodsSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
shopReplace 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-categoriesSuggested headers
Accept: application/json
lang: enAccess 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-mastersSuggested headers
Accept: application/json
lang: enAccess 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.
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-areasSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
relicReplace 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: enAccess conditions
No sign-in required
Path parameters
relicareaReplace 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}/availabilitySuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
relicareaReplace 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}/registrationsSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
relicareaReplace 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}/registrationsSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
relicareaReplace 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/donationsSuggested headers
Accept: application/json
lang: enAccess 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/donationsSuggested headers
Accept: application/json
lang: enAccess 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-capabilitiesSuggested headers
Accept: application/json
lang: enAccess 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-statusSuggested headers
Accept: application/json
lang: enAccess conditions
Lookup / registration code
Path parameters
donationReplace 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.
Community & pilgrimage8 API
Pilgrimage journals, comments, feedback and conversational assistance.
GETPublic pilgrimage journals/api/pilgrimage-journals
Usage details
https://api.denbaoha.vn/api/pilgrimage-journalsSuggested headers
Accept: application/json
lang: enAccess 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/filterSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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}/commentsSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
journalReplace 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}/shareSuggested headers
Accept: application/json
lang: enAccess conditions
No sign-in required
Path parameters
journalReplace 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/commentsSuggested headers
Accept: application/json
lang: enAccess 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/reflactsSuggested headers
Accept: application/json
lang: enAccess 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/messagesSuggested headers
Accept: application/json
lang: enAccess 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.
Reference data5 API
Administrative divisions, positions and shared filters.
GETList provinces and cities/api/provinces
Usage details
https://api.denbaoha.vn/api/provincesSuggested headers
Accept: application/json
lang: enAccess 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/wardsSuggested headers
Accept: application/json
lang: enAccess 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-provinceSuggested headers
Accept: application/json
lang: enAccess 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/positionsSuggested headers
Accept: application/json
lang: enAccess 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/filtersSuggested headers
Accept: application/json
lang: enAccess 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.
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-infoSuggested headers
Accept: application/json
lang: enAccess 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/bannersSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
keyReplace 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-manualsSuggested headers
Accept: application/json
lang: enAccess 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/faqsSuggested headers
Accept: application/json
lang: enAccess 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/categorySuggested headers
Accept: application/json
lang: enAccess 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/categoriesSuggested headers
Accept: application/json
lang: enAccess 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/filterSuggested headers
Accept: application/json
lang: enAccess 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: enAccess conditions
No sign-in required
Path parameters
idReplace 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-summarySuggested headers
Accept: application/json
lang: enAccess 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.
Registration & authentication5 API
Sign-in and registration endpoints available before authentication.
POSTSign in/api/auth/login
Usage details
https://api.denbaoha.vn/api/auth/loginSuggested headers
Accept: application/json
lang: enAccess 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/registerSuggested headers
Accept: application/json
lang: enAccess 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-passwordSuggested headers
Accept: application/json
lang: enAccess 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-codeSuggested headers
Accept: application/json
lang: enAccess 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-governmentSuggested headers
Accept: application/json
lang: enAccess conditions
Lookup / registration code
Requires a valid government_code and the registration information required by the system.
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/callbackSuggested headers
Accept: application/json
lang: enAccess 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/aiboxSuggested headers
Accept: application/json
lang: enAccess 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
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | List heritage sites/api/relics | No sign-in required |
| GET | Paginated heritage categories/api/relics/category | No sign-in required |
| GET | Heritage filters/api/relics/filter | No sign-in required |
| GET | Featured heritage site/api/relics/featured-detail | No sign-in required |
| GET | Heritage site details/api/relics/detail/{id} | No sign-in required |
| GET | Heritage categories/api/relic-categories | No sign-in required |
| GET | Areas within a heritage site/api/relics/{relic}/areas | No sign-in required |
| GET | Heritage area details/api/relics/{relic}/areas/{area} | No sign-in required |
| GET | Look up a heritage area/api/relic-areas/detail/{area} | No sign-in required |
360° spaces & maps
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | List 360° tours/api/relics/{relic}/360-tours | No sign-in required |
| GET | 360° tour details/api/relics/{relic}/360-tours/{tour} | No sign-in required |
| GET | Temple map for a heritage site/api/relics/{relic}/temple-map | No sign-in required |
| GET | List worship spaces/api/le-bai/spaces | No sign-in required |
| GET | Worship space details/api/le-bai/spaces/{slug} | No sign-in required |
| GET | List worship models/api/le-bai/models | No sign-in required |
| GET | AI assistant model/api/le-bai/models/ai-home-bot | No sign-in required |
| GET | Heritage sites with worship spaces/api/le-bai/relics | No sign-in required |
| GET | Worship space by heritage site/api/le-bai/relics/{relicSlug}/spaces/{spaceSlug} | No sign-in required |
| GET | Worship space by heritage area/api/le-bai/relics/{relicSlug}/areas/{areaSlug}/spaces/{spaceSlug} | No sign-in required |
Artifacts
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | List artifacts/api/artifacts | No sign-in required |
| GET | Paginated artifact categories/api/artifacts/category | No sign-in required |
| GET | Artifact categories/api/artifact-categories | No sign-in required |
| GET | Artifact filters/api/artifacts/filter | No sign-in required |
| GET | Artifact details/api/artifacts/detail/{id} | No sign-in required |
| GET | Artifact details (short path)/api/artifacts/{id} | No sign-in required |
Culture & research
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | List cultural articles/api/articles | No sign-in required |
| GET | Cultural article categories/api/articles/category | No sign-in required |
| GET | Cultural article filters/api/articles/filter | No sign-in required |
| GET | Cultural article details/api/articles/detail/{id} | No sign-in required |
| GET | List scientific documents/api/science-docs | No sign-in required |
| GET | Scientific document categories/api/science-docs/category | No sign-in required |
| GET | Scientific document details/api/science-docs/detail/{id} | No sign-in required |
News & events
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | List news/api/news | No sign-in required |
| GET | Paginated news/api/news/list | No sign-in required |
| GET | News filters/api/news/filters | No sign-in required |
| GET | News details/api/news/{news} | No sign-in required |
| GET | News categories/api/news-categories | No sign-in required |
| GET | News category details/api/news-categories/{news_category} | No sign-in required |
| GET | List events/api/events | No sign-in required |
| GET | Paginated events/api/events/list | No sign-in required |
| GET | Event filters/api/events/filters | No sign-in required |
| GET | Event details/api/events/{event} | No sign-in required |
| GET | Event categories/api/event-categories | No sign-in required |
| GET | Event category details/api/event-categories/{event_category} | No sign-in required |
Images & audio
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | Image library/api/library-images | No sign-in required |
| GET | Filtered image list/api/library-images/list | No sign-in required |
| GET | Image details/api/library-images/{library_image} | No sign-in required |
| POST | Upload an image/api/upload-imageSend multipart/form-data with the upload file field. | No sign-in required |
| POST | Synthesize speech from text/api/tts/vbeeBody: 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 |
| GET | Speech 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
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | List local services/api/local-services | No sign-in required |
| GET | Local service categories/api/local-services/categories | No sign-in required |
| GET | Service categories (alias)/api/local-services/category | No sign-in required |
| GET | Local service filters/api/local-services/filter | No sign-in required |
| GET | Local service details/api/local-services/detail/{id} | No sign-in required |
| GET | Service details (short path)/api/local-services/{id} | No sign-in required |
| POST | Register a local service/api/local-services/registrations | No sign-in required |
| POST | Look up a service registration/api/local-services/registrations/lookupSend code and contact (the email or phone matching the registration) in the body. | Lookup / registration code |
| GET | List shops/api/shops | No sign-in required |
| GET | Shop details/api/shops/{shop} | No sign-in required |
| GET | Shop products/api/shops/{shop}/products | No sign-in required |
| GET | Shop reviews/api/shops/{shop}/reviews | No sign-in required |
| GET | Shop payment methods/api/shops/{shop}/payment-methods | No sign-in required |
| GET | Product and ritual offering categories/api/product-categories | No sign-in required |
| GET | List ritual masters/api/ritual-masters | No sign-in required |
Ceremonies & donations
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | List ceremony areas/api/relics/{relic}/cung-hau-areas | No sign-in required |
| GET | Ceremony area details/api/relics/{relic}/cung-hau-areas/{area} | No sign-in required |
| GET | Check ceremony availability/api/relics/{relic}/cung-hau-areas/{area}/availabilityRequires a date query in YYYY-MM-DD format. Optional: hau_start_time (HH:mm), start_time or relic_area_id. | No sign-in required |
| GET | Confirmed ceremony schedule/api/relics/{relic}/cung-hau-areas/{area}/registrations | No sign-in required |
| POST | Submit a ceremony registration/api/relics/{relic}/cung-hau-areas/{area}/registrations | No sign-in required |
| GET | Public donation list/api/donations | No sign-in required |
| POST | Submit a donation/api/donations | No sign-in required |
| GET | Donation payment capabilities/api/donations/payment-capabilities | No sign-in required |
| GET | Donation payment status/api/donations/{donation}/payment-statusRequires the valid query token issued for the corresponding donation. | Lookup / registration code |
Community & pilgrimage
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | Public pilgrimage journals/api/pilgrimage-journals | No sign-in required |
| GET | Pilgrimage journal filters/api/pilgrimage-journals/filter | No sign-in required |
| GET | Pilgrimage journal details/api/pilgrimage-journals/{id} | No sign-in required |
| GET | Pilgrimage journal comments/api/pilgrimage-journals/{journal}/comments | No sign-in required |
| POST | Record a journal share/api/pilgrimage-journals/{journal}/share | No sign-in required |
| GET | List comments/api/comments | No sign-in required |
| POST | Submit feedback/api/reflacts | No sign-in required |
| POST | Message the conversational assistant/api/chat/messagesSupports 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
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | List provinces and cities/api/provinces | No sign-in required |
| GET | List wards and communes/api/wards | No sign-in required |
| GET | Wards by province/api/wards-by-province | No sign-in required |
| GET | Government positions/api/government/positions | No sign-in required |
| GET | Shared filters/api/filters | No sign-in required |
Information & support
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| GET | Site and contact information/api/site-info | No sign-in required |
| GET | List banners/api/banners | No sign-in required |
| GET | Static content by key/api/template-statics/{key} | No sign-in required |
| GET | User manuals/api/user-manuals | No sign-in required |
| GET | List frequently asked questions/api/faqs | No sign-in required |
| GET | Paginated FAQ categories/api/faqs/category | No sign-in required |
| GET | FAQ categories/api/faqs/categories | No sign-in required |
| GET | FAQ filters/api/faqs/filter | No sign-in required |
| GET | FAQ details/api/faqs/detail/{id} | No sign-in required |
| GET | Public application traffic summary/api/public-reports/app-traffic-summary | No sign-in required |
Registration & authentication
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| POST | Sign in/api/auth/login | No sign-in required |
| POST | Register a user account/api/auth/register | No sign-in required |
| POST | Request password recovery/api/auth/forget-password | No sign-in required |
| POST | Verify a government registration code/api/auth/verify-government-codeRequires an issued government registration code (code). | Lookup / registration code |
| POST | Register a government account/api/auth/register-governmentRequires a valid government_code and the registration information required by the system. | Lookup / registration code |
Event integrations
| Method | API name / Endpoint | Access conditions |
|---|---|---|
| POST | Speech service callback/api/tts/vbee/callbackCallback receiver for the speech provider; not a data query endpoint. | Service callback |
| POST | Receive AI Box events/api/webhooks/aiboxReceives 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.
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.
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.
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.
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.