
The Management API is a RESTful interface to any action you can do in your account of the CraftAR Service.
Use the Management API to integrate CraftAR functionalities in your applications and services. It allows you to programmatically access and manipulate all resources found in CraftAR.
The API follows a RESTful architecture, uses HTTPS exclusively and accepts and returns JSON. This document contains a detailed description of the API calls.
We provide PHP and Python libraries for the Management API. Thanks to our customers, we also have implementations of this API for .NET, and Ruby.
1 |
https://my.craftar.net/api/v0/RESOURCE/?api_key=API_KEY |
1 |
GET https://my.craftar.net/api/v0/collection/?api_key=123456789abcdefghijk123456789abcdefghijk |
1 |
GET https://my.craftar.net/api/v0/collection/?api_key=123456789abcdefghijk123456789abcdefghijk |
1 |
GET https://my.craftar.net/api/v0/collection/ |
Invalid API key
HTTP Status code: 403 Forbidden
1 2 3 4 5 6 |
{ "error": { "message": "Invalid API key.", "code": "AUTHENTICATION_FAILED" } } |
1 2 3 4 5 6 7 8 9 10 |
{ "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 0 }, "objects": [] } |
1 |
curl 'https://my.craftar.net/api/v0/collection/?api_key=123456789abcdefghijk123456789abcdefghijk&limit=5' |
1 |
curl 'https://my.craftar.net/api/v0/collection/?api_key=123456789abcdefghijk123456789abcdefghijk&limit=5&offset=5' |
1 |
curl 'https://my.craftar.net/api/v0/collection/?api_key=123456789abcdefghijk123456789abcdefghijk&limit=5&offset=10' |
Create a new collection.
Delete an existing collection
Retrieve a single collection by ID
Retrieve a list of collections
Update an existing collection.
Create a new item
/api/v0/collection/UUID/
["/api/v0/tag/UUID1/", "/api/v0/tag/UUID2/"]
Delete an existing item
Retrieve a single item by UUID
Retrieve a list of items
Update an existing item
["/api/v0/tag/UUID1/", "/api/v0/tag/UUID2/"]
Create a new image
/v0/item/UUID/
Delete an existing image
Retrieve a single image by UUID
Retrieve a list of images
Create a new Tag in a given Collection. You should contact support to enable this feature int your account.
Delete an existing tag
Retrieve a single Tag by UUID
Retrieve a list of tags
Create a collection bundle for an offline SDK or, regenerate it if a bundle with the same parameters already exists.
Delete an existing Collection Bundle
Retrieve a single Collection Bundle by ID
Retrieve a list of Collection Bundles
Create a new Application ID
Retrieve a single Application ID by ID
Retrieve a list of Application ID
None
Retrieve a single SDK version by ID
Retrieve a list of available SDK versions
Create a new token.
/v0/collection/UUID/
Delete an existing token
Retrieve a list of tokens
["/api/v0/tag/UUID1/", "/api/v0/tag/UUID2/"]
Create a new media
Delete an existing media
Retrieve a single media object by UUID
Retrieve a list of media objects