API Overview

Overview
Authentication
URL
Resources
Response Data
Request Data
Debugging

Introduction
The Sinefa API allows you to interact with our system programmatically from your own application. The API allows you to perform configuration changes and access reporting information.

The API attempts to conform to the RESTful design principles. You interact with the resources exposed via the API by accessing resource URIs using the HTTP verbs (GET, POST, PUT, and DELETE). Sinefa accepts and returns JSON data via the API.

You'll likely need access to a web developer or programmer (if you’re not one) to get the most use out of the API.

Authentication
Authentication is implemented as HTTP Basic Authentication over SSL (https) or by using an API key, as described in Authentication.

URL
The URL for API requests is typically:

https://<region>-app.sinefa.com/<resource URI>

Where region is the Sinefa region your account in hosted in (e.g. 'ap1'). This can be found at the bottom of the settings menu on the UI.

Note: This will be different if you self-host a controller.

Resources
The available resources are:

• Reporting (v2)
• Reporting: Summary (v1)
• Reporting: Utilization (v1)
• Reporting: Quality
• Reporting: Capacity
• Events: Active
• Shaping

Response Data
Response data is sent as JSON. Response codes are sent via the normal HTTP Response Code, and are documented separately for each resource.

Request Data
POST and PUT request data must be formatted as JSON (application/json). For best results, you should set your HTTP Content-Type request header accordingly.

All timestamps must be specified in milliseconds since epoch with a time-zone of Coordinated Universal Time (UTC).

Debugging
If you’re having difficulty executing a request via our API, try the simplest thing and attempt your request via the curl command-line tool, as shown in the below example. Add the --verbose flag to your request to receive even more debugging information. For example:

curl --verbose -u '<username>:<password>' -H 'Content-Type: application/json' https://<region>-app.sinefa.com/api/v1/user.json

Another handy tool is RequestBin. You could create a RequestBin and send your request to them instead of us to see visually what it is you’re sending, if you’re not sure.

See Also
API Authentication
How to generate date specific reports using API queries
Reporting (v2)
Reporting: Summary (v1)
Reporting: Utilization (v1)
Reporting: Quality
Reporting: Capacity
Events: Active