Souvenirs
API information
The souvenir
resource is managed by the Souvenirs API.
XPKit Portal
It is recommended souvenirs are configured in XPKit Portal, rather than making direct API requests.
Service URLs
Region | URL |
---|---|
AMER | https://souvenirs.amer.xpkit.net |
APAC | https://souvenirs.apac.xpkit.net |
China | https://souvenirs.china.xpkit.cn |
EMEA | https://souvenirs.emea.xpkit.net |
OpenAPI Specification
Resource name | Documentation | Download |
---|---|---|
Souvenir | View | Link |
Example souvenir
{
"name": "Successfully Registered - badge",
"url": "https://souvenirs.s3.amazonaws.com/registration_complete_badge.png",
"type": "image",
"experience_id": "developer-conference-2022",
"moment_ids": [
"973462c9-6f48-4ee0-947a-0a3cafa359e1",
"b81e4897-72ab-4d6f-9ff6-5a5d32c4e976"
]
}
Notes on souvenirs
- The Moment IDs (moment_ids) are UUID references to moments.
- Souvenirs are associated to one
experience
but can be duplicated for other experiences. - The Catalogue API can be used to determine whether a visitor has qualified for a
souvenir
.