Call Syntax¶
API calls to Bits on the Run are in essence just HTTP requests to a specific location. The parameters of each call can be sent using either POST or GET. A number of parameters are always required: those for signing the call and the one for defining the output format.
Syntax¶
The API has a single entry point (api.bitsontherun.com) that can work with multiple input/output formats. For the input, both GET and POST requests are accepted. The call syntax is:
<http|s>://<APIserver>/<APIversion>/<callClass>/<callSubclass>/<method|attribute>[?<parameters>]
- http|s
- Connection protocol: HTTP or HTTPS
- APIserver
- API server i.e: api.bitsontherun.com
- APIversion
- API version
- callClass
- Class of the API call
- callSubclass
- Subclass of the API call
- method|attribute
- API call method or attribute
- parameters
- API call parameters
In cases where large binary data is submitted (videos and images), this data should be included in the body of the HTTP POST request. The binary data should be included as-is, without any encoding.
