General information

General API information

The API base URL is https://api.pops3d.com/.

All API calls are implemented as HTTP POST. Unless the request irrecoverably crashes, the HTTP response code is always 200 and the error, if any, is specified via the result field in the response (which can be either ok or error).

Authentication

Each request to the API must contain an API key for authentication, in an apiKey parameter. API keys can be generated in your dashboard.

Note that you should keep your API key secret, as anyone knowing it could run requests on your behalf.

Request data

All request data posted to the API must be in JSON objects. The documentation for each API route describes the request data parameters in detail.

Return data

Return data from the API is in JSON objects.

Content-type

Set the Content-Type header to application/json on all requests.

Rate-limiting

There is no rate-limiting on our part for receiving API requests (you might still hit a rate limit from AWS if sending requests really, really fast). However, we put requests in priority queues: if you send requests faster than your pictures are processed, the first requests will be queued in the highest priority queue. Once it's filled, subsequent requests will be put in lower priority queues, until a spot is freed in the higher priority queue. This shouldn't cause significant delays unless many other customers have a lot of queued pictures as well. However, it may cause pictures to be treated in a different order than submitted.

Important note about picture orientation

Intput pictures must be properly oriented: the top must point towards the top, not to the left or right (or bottom, to a lesser extent). Unlike flat prints, 3D prints must be processed in the same orientation as the picture will be physically viewed, otherwise the 3D effect won’t work. An upside-down picture will have working 3D, but the depth map will likely be (very) degraded.