Swrve Items API guide
View item
This API call gets an item (or all items) from the app (HTTP GET). This function is intended for use from your application’s resource editor. Do not call it from the app client or the app server. The A/B Test API contains an API called /resources/ that should be called from the app client or the app server. The A/B test server is designed for high-performance, high-availability serving of app resources.
Request method
GET
URL
US
https://dashboard.swrve.com/api/1/items
EU
https://eu-dashboard.swrve.com/api/1/items
Examples
List all items in the app:
US
curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" \ https://dashboard.swrve.com/api/1/items
EU
curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" \ https://eu-dashboard.swrve.com/api/1/items
List attributes for the item with unique ID rf65 in the app:
US
curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" -d "item=rf65" \ https://dashboard.swrve.com/api/1/items
EU
curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" -d "item=rf65" \ https://eu-dashboard.swrve.com/api/1/items
URL parameters
| Parameter | Presence | Description |
|---|---|---|
| api_key | Required | The API key for the app. |
| personal_key | Required | The personal key for your user login. |
| item | Optional | If item is not supplied, the array of all items is returned, otherwise the item with this unique ID is returned. |
Error codes
If an error occurs while processing the request, you may receive one or more of the following error codes and need to make sure your integration is equipped to handle error conditions.
| Code | Text | Description |
|---|---|---|
| 400 | Invalid JSON | The JSON object is invalid. |
| 403 | Forbidden | Invalid authorization parameters. Check that your API key is correct. |
| 404 | No matching resource found | The item ID does not exist. Check the item list and verify the item ID is correct. |
| 503 | Service Unavailable | An error occurred on the Swrve server side. Attempt to send the request at a later time, if possible. |
Create (or update) item
This API call creates or updates a single item (HTTP POST).
Request method
POST
URL
US
https://dashboard.swrve.com/api/1/items
EU
https://eu-dashboard.swrve.com/api/1/items
Examples
Create a new item in the app including a thumbnail:
US
curl -d "api_key=<api key>" -d "personal_key=<personal key>" \
-d "item=teapot" -d 'data={"name": "Green Teapot", "size": 4, "thumbnail": \
"http://example.com/images/teapot_thumb.png"}' https://dashboard.swrve.com/api/1/items
EU
curl -d "api_key=<api key>" -d "personal_key=<personal key>" \
-d "item=teapot" -d 'data={"name": "Green Teapot", "size": 4, "thumbnail": \
"http://example.com/images/teapot_thumb.png"}' https://eu-dashboard.swrve.com/api/1/items
Update an existing item in the app (assuming an item teapot already exists):
US
curl -d "api_key=<api key>" -d "personal_key=<personal key>" \
-d "item=teapot" -d 'data={"name": "Big Green Teapot", "size": 8}' \
https://dashboard.swrve.com/api/1/items
EU
curl -d "api_key=<api key>" -d "personal_key=<personal key>" \
-d "item=teapot" -d 'data={"name": "Big Green Teapot", "size": 8}' \
https://eu-dashboard.swrve.com/api/1/items
URL parameters
| Parameter | Presence | Description |
|---|---|---|
| api_key | Required | The API key for the app. |
| personal_key | Required | The personal key for your user login. |
| item | Required | The unique ID (UID) of an item when creating, updating or listing a single item. |
| data | Required |
This is a JSON string of key/value pairs (restricted to string and integer keys and values) that become the attributes of an item. Wrap all strings in double quotes (“), including key names.
Do not specify the UID of an item here as you have already specified it in the item parameter. Any value for UID is ignored.If no name attribute is specified in the data, the UID value is used as the item’s name.
A nil value for an attribute indicates the attribute should be removed. The created_at and updated_at fields are special parameters which set the corresponding special attributes shown on an item’s page.
To set the item’s class, include item_class; for example, data={“name”:”Teapot”, “item_class”:”Kitchenware”}.
|
Error codes
See View Item.
Bulk item upload
This API call creates or updates a batch of items in a single HTTP POST request.
By adhering to the expected maximums (that is, the level of usage to which the Swrve service has been tuned for reasonable performance in the GUI for bulk export), you can usually avoid encountering issues with the Bulk Item API. The limit for the Bulk Item API varies (depending on the number of items modified and the size of POST data) and presents itself as a network timeout. The recommended best practice is to catch this in your code, as the Bulk Item API updates items in a transaction and will rollback if it’s unsuccessful.
Request method
POST
URL
US
https://dashboard.swrve.com/api/1/items_bulk
EU
https://eu-dashboard.swrve.com/api/1/items_bulk
Example
Create or update two items at once:
US
curl -d "api_key=<api key>" -d "personal_key=<personal key>" \
-d 'data={"first-uid": {"name": "Green Teapot", "size": 4}, "second-uid": \
{"name": "Red Teapot", "size": 2}}' https://dashboard.swrve.com/api/1/items_bulk
EU
curl -d "api_key=<api key>" -d "personal_key=<personal key>" \
-d 'data={"first-uid": {"name": "Green Teapot", "size": 4}, "second-uid": \
{"name": "Red Teapot", "size": 2}}' https://eu-dashboard.swrve.com/api/1/items_bulk
URL parameters
| Parameter | Presence | Description |
|---|---|---|
| api_key | Required | The API key for the app. |
| personal_key | Required | The personal key for your user login. |
| data | Required |
This is a JSON string where each key should be an item’s UID and each value will itself be a JSON string of key/value pairs (restricted to string and integer keys and values) that become the attributes of that item.
Wrap all strings in double quotes (“), including key names.
A nil value for an attribute indicates the attribute should be removed. The created_at and updated_at fields are special parameters which set the corresponding special attributes shown on an item’s page.
To set the item’s class, include item_class; for example, data={“item-uid”: {“name”:”Teapot”, “item_class”:”Kitchenware”}}.
|
Error codes
See View Item.