Diamra Docs
All pages

API

The API lets your server work with your store. The path carries the version: inside /v1 things are only added, never renamed or removed. Every call except Health takes an API key, which you create in your store's Developer Console. The first calls sign your customers up and log them in on your own website, keep the photos they send, make jewelry designs from what they describe and those photos, and start projects from the designs they pick. The API comes with the Retail plan.

Base URLhttps://api.diamra.com/v1

Call it over HTTPS. A request over plain HTTP gets a 403 and is never redirected, so an http:// address fails on the first call instead of working while it sends your key in clear text.

Every response carries a Request-Id header. Quote it when you write to us about a call. Errors come as an error object with a type, a message in plain words and, where your code can act on it, a code to branch on. When one parameter is at fault, param names it.

In this part