Get Started

The Distributive Receiver API allows users to queue alarm events for Central Stations. Prior to completing calls to this API, you should coordinate with your Central Station to determine a dnis and range of panel codes.

This documentation will walk you through authentication and making your first API call. We will call the Heartbeat endpoint within this documentation.

Audience #

This documentation is intended for users who understand how to make REST API calls. It is assumed you are familiar with making HTTP web requests in your preferred programming language.

Authentication #

Each call you make will need to contain authentication information to validate the request.

Making a call #

Below is a cURL example of calling the Heartbeat endpoint.

The Heartbeat endpoint allows users to perform the necessary call that notifies the driver that the source of alarm events is healthy. Users must call this endpoint every 20 seconds.

Example request #

curl --location --request POST 'https://{DOMAIN}/rx/{SOURCE:DESTINATION}/hb' \
--header 'Authorization: Bearer {HTTP_BEARER_TOKEN}'

The {DOMAIN}, {SOURCE:DESTINATION}, and {HTTP_BEARER_TOKEN} are provided by DICE.

Example response #

{
    "status_code": 200,
    "status": "success"
}