| |
|
|
UniFlip REST API documentation
Intro to UniFlip REST API
The REST API enables developers to access some of the core primitives of UniFlip including uploading files,
publication lists, and publication informations. If you're building application that leverages core UniFlip
publications, then this is the API for you. Imagine building a publication: name, list of publications,
their layouts - all with a few RESTful API calls. In addition to offering programmatic access to the
publications objects, this API also enables developers a multitude of integration opportunities to
Through the REST API, the user can create and post publicaitons back to UniFlip, edit the publications,
activate the licenses, and more.
The API is entirely HTTP-based
Methods to retrieve data from the UniFlip API require a GET request. Methods that submit, change,
or destroy data require a POST.
API Methods that require a particular HTTP method will return an error if you do not make your
request with the correct one. HTTP Response Codes are meaningful.
REST API parameters
Some API methods take optional or requisite parameters.
- Parameter values should be converted to UTF-8
- Parameter values should be URL encoded
HTTP Status Codes
The UniFlip REST API attempts to return appropriate HTTP status codes.
| Code |
Text |
Description |
| 200 |
OK |
Success! |
| 400 |
Bad request |
The request was invalid. An accompanying error message will explain why. |
| 401 |
Unauthorized |
Authentication credentials were missing or incorrect. |
| 403 |
Forbidden |
The request is understood, but it has been refused. An accompanying error message will explain why. |
| 404 |
Not found |
The URI requested is invalid or the resource requested, such as a user, does not exists. |
| 500 |
Internal Server Error |
Something is broken. Please post to the support so the UniFlip team can investigate. |
| 502 |
Bad Gateway |
UniFlip is down or being upgraded. |
REST API Resources
Here you can find informations about each API call.
|
|
