Identifiers
Project key
Each project has two identifiers, both set when the project is created in PulpoAR Studio:
| Identifier | Set by | Can change? |
|---|---|---|
| Slug | You. It must be unique. | Yes, but integrations that use the old slug stop working |
| UUID | Generated automatically | No |
You can use either one in plugin URLs and API calls. Both give the same result:
https://plugin.pulpoar.com/vto/<slug>
https://plugin.pulpoar.com/vto/<uuid>
Slugs are easier to read. If you might rename the project slug later, use the UUID in production integrations instead.
Catalog slugs
Brands, categories, products and variants also have slugs. A slug is a unique identifier you define when you create the item. You can change it later, but it must stay unique.
| Item | Used in |
|---|---|
| Category | .../vto/<project-key>/category/<slug> |
| Brand | .../vto/<project-key>/brand/<slug> |
| Product | .../vto/<project-key>/product/<slug>, Partner API product_key, native initialSelection |
| Variant | .../vto/<project-key>/variant/<slug>, SDK applyVariants, catalog actions, Partner API stock updates |
| Look | .../vto/<project-key>/look/<id>. Looks use their ID. |
Variant slugs
Variant slugs are the most important identifiers for integrations:
- SDK actions such as
applyVariantsandsetVariantsStatusfind variants by slug. - The Partner API stock endpoint updates variants by slug.
- Variants without a slug can't be applied through the SDK.
A good practice is to use your own SKU, or another stable product ID from your system, as the variant slug.
Analytics app key
The Analytics API uses a separate analytics app key (app_key) assigned to your VTO experience. It's not the same as the project key.