Overview

This describes the resources that make up the official Flipbase REST API v1. The Flipbase API enables access to resources like organizations, collections and videos. If you have any problems or requests, please contact Flipbase Support.

Authentication

When you want to use the API you need an api_key and an api_secret, provided by Flipbase. The api_secret will be used to generate signatures to send authenticated requests.

Authentication of the API is modeled after Amazon's signed URL framework. The API utilizes RFC 2104 and RFC 4868 compliant HMAC's.

There are 2 authentication methods you can use to authenticate with the API: signed requests and JSON Web Tokens.

Error Codes

Authentication errors

HTTP/1.1 401 Unauthorized

{
  "message": "Bad credentials"
}

Invalid request

There are three possible types of client errors on API calls that receive request bodies. Sending invalid JSON will result in a 400 Bad Request response:

HTTP/1.1 400 Bad Request
Content-Length: 35

{
  "message": "Problems parsing JSON"
}

Sending the wrong type of JSON values will result in a 400 Bad Request response.

HTTP/1.1 400 Bad Request
Content-Length: 40

{
  "message": "Body should be a JSON object"
}

Sending invalid fields will result in a 422 Unprocessable Entity response.

HTTP/1.1 422 Unprocessable Entity
Content-Length: 149

{
  "message": "Validation Failed",
  "errors": [
    {
      "resource": "Videos",
      "field": "formats",
      "code": "missing_field"
    }
  ]
}