API Overview
Introduction
The Getflix API allows you to interact with our system programmatically, over a secure, authenticated HTTPS connection.
Our API conforms to RESTful design principles. You interact with resources exposed via the API by accessing resource URIs using the HTTP verbs (GET, POST, PUT, and DELETE). Getflix 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). The username is your API Key (which can be found under the '
Apps' section when you login to our website). The password is always 'x'.
Accessing our API using curl might look something like this:
Accessing our API using curl might look something like this:
curl -u <api_key>:x -X GET https://www.getflix.com.au/api/v1/addresses.json
Be sure to keep your API Key safe, treat it like a password, since it effectively gives you full access to your account.
URL
The URL for API requests is:
https://www.getflix.com.au/api/<resource_uri>
Resources
The available resources are:
- IP Addresses - Allows you to get and set the IP addresses registered with your Getflix account.
- Profile - Allows you to get and set user profile information.
- Regions - Allows you to get and set region switching information for you Getflix account.
- Subscription - Returns information about the user's subscription.
- System - Returns information about the system.
- DNS Test - Tests if the current device's DNS is configured correctly.
Response Data
Response data is sent as JSON. Response codes are sent via the normal HTTP response code:
- 200: OK
- 400: Bad Request
- 401: Not Authorized
- 403: Forbidden
Windows Users
When using curl for Windows and POSTing JSON to our API, you need to escape strings like this:
curl -u YOUR_API_KEY:x -X POST -d "{ \"service\": \"netflix\", \"region\": \"AU\"}" https://www.getflix.com.au/api/v1/regions.json