-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Here's how the process works:
- A developer (you) registers with Active911 in order to create apps.
- Once registered, a developer may register one or more apps. Each app represents a particular product that will be accessing Active911. Each app is assigned a key.
- An Active911 account (normal user account) clicks on the account tab and scrolls down to generate an API keys with permissions on that one account. They give the key to you.
- Your app contacts the API URL and begins pushing and pulling data.
An API request or command is an HTTPS POST to https://access.active911.com/interface/open_api.php
. Required POST parameters are as follows:
Parameter | Description |
---|---|
app_key | Your App Key, e.g. an3as8#12!33Sjd78sS@ |
api_key | The API key from the account you want to access |
operation | An operation to perform |
Some operations also require operation-specific parameters, as defined on the operations page. For example, if you want to get data on device 1234, Lt. John Doe's iPhone, you will need to pass operation=get_device
as well as device_id=1234
.
The first time your app contacts the API server, the API key you present becomes locked to your app. The key can no longer be used by any other app. If the user wants to provide data access to more than one app, they must generate multiple API keys.
All operations result in a response. Response is always in JSON format, and at a minimum contains two keys: result
and message
. result
is always either success
or error
, and message
is either a string with a relevant error message, or else the response data you requested. If you are issuing a command, message
may be blank. For example, suppose you tell the API to move a map marker from point A to B:
{
"result" : "success",
"message": "Map marker moved successfully"
}
or if you issue an invalid command:
{
"result" : "error",
"message": "Please specify a valid device_id"
}
For a list of valid API operations, please see the Operations page