Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

3rd party applications must use the Authorization Code workflow, starting with a request to https://access.active911.com/interface/open_api/authorize_agency.php by using a GET request. This workflow requires you to be logged in to the Active911 website and to have edit_agency permission on the agency you want to generate the auth code for.

Parameter

Required

Description

client_id

yes

The client_id given to your application when you registered it with us

response_type

yes

Currently we only support the Authorization Code workflow, so this must be set to "code"

redirectionredirect_uri

yes

The url you want the user to be redirected to after they authorize your request

scope

yes

The permissions you are requesting access for. This is a space delimited list of one or more of these scopes. The scopes you can request are limited to the ones the application is registered for.

state

no

You may set this to a particular value, and that value will be resent upon redirection after authorization

...

Parameter

Required

Description

client_id

yes

The client_id given to your application when you registered it with us

client_secret

yes

The client_secret given to your application when you registered it with us

grant_type

yes

For initial token generation, this must be set to "authorization_code"

scope

yes

The permissions you are requesting access for.

code

yes

The Authorization code you generated.

This will return a JSON object with:

Code Block
languagejson
{
 "access_token": "<The access token used to access the api>", 
 "token_type": "Bearer", 
 "expires_in": "<Seconds until the access token expires>" , 
 "refresh_token": "<The refresh token used to get a new access token when this one expires>", 
 "scope": "<The scope of permissions granted to this token.  May be less than the scope requested>"
}

...

This will return a JSON object with:

Code Block
languagejson
{
 "access_token": "<The access token used to access the api>", 
 "token_type": "Bearer", 
 "expires_in": "<Seconds until the access token expires>" , 
 "refresh_token": "<The refresh token used to get a new access token when this one expires>", 
 "scope": "<The scope of permissions granted to this token.  May be less than the scope initially requested>"
}