Skip to Content

How an integration works

What the API does, how your system and CharpstAR exchange products and files, and what a typical integration looks like.

Connect your product system to CharpstAR. Send us your products, follow them through production, and get the finished 3D models, AR links and product images back, ready for your shop.

What you can do

  • Send products in. Create or update a product by its article number. Our team models it, checks it and delivers it.
  • Get finished files out. For every article you get its status, the 3D files, a viewer link, an AR link and approved images, one at a time or up to 100 at once.
  • Hear about changes. Signed events tell your system the moment a product is received, moves forward, is approved, or gets new images.

Everything works on your article number: the number you already use in your product system and on your product pages. You never need our internal ids.

The flow

  1. Your ERP or PIM sends new and changed products with POST /api/v1/products.
  2. CharpstAR models, checks and delivers each product, and runs the renders and AI images you order.
  3. Your integration receives events, reads the asset with GET /api/v1/assets/{article} and writes files and links back to your system.

Any system that can make HTTPS requests can connect, including integration platforms.

A typical integration

  • Sends new and changed products as they happen, or in a nightly batch.
  • Listens for events and reads the asset when something changes.
  • Runs a daily sync with GET /api/v1/assets?since= to catch anything missed.
  • Has the embed code in the product page template.

Loading a full catalogue

For the first load of a large catalogue, use an import: one file with all your products, processed in the background with a result for every row. Smaller loads can use POST /api/v1/products in batches of 50.

Requests and responses

The base URL is https://platform.charpstar.co. Requests and answers are JSON over HTTPS, field names are camelCase, and times are ISO 8601 in UTC.

API access is switched on per company. Your CharpstAR contact switches it on, and you make your keys yourself, as described in Authentication.

On this page