iRPv2
Automatically Initiate a Query and Display the Data
IamResponding (IaR)
ECCs/PSAPs
Request for Knowledge Article
iRPv2

Overview

RapidSOS offers this API endpoint for partners interested in embedding RapidSOS Portal directly into their pre-existing solution. This solution allows the ability to embed the full portal with the map, or can simply provide additional data cards (without the map) depending on your integration requirements.

This is a multi-step process that involves:

  1. requesting an authentication token (OAuth2.0)
  2. passing the token in a request for a unique URL
  3. launching the RapidSOS Portal (RSP)

Using your integration’s client credentials combined with a valid login for RapidSOS Portal (RSP), you can use our Deeplink API POST /oauth/v2/token to generate a secure URL that can be opened in a browser to automatically populate the user’s session and search for a specific phone number or Alert ID. This allows for a seamless automatic display of rich data as rendered by the Portal natively inside your application.

Requirements

  1. This solution requires that the CAD/CPE/Automation integration have access to RSP user credentials and RapidSOS Integration credentials in order to authenticate to iRP v.2.
  2. Additionally, auto-open browser solutions require that CAD/CPE/Automation integrations have the capability to open a web browser within or alongside their solution to a given URL on the open internet. (refer to the Writing The Configuration documentation for more information)
  3. Integration users should be prompted to log into the iRPv2 integration each time they sign into CAD with their unique username and password used for their RapidSOS portal account.

Create a RapidSOS Portal User for Token Creation

RapidSOS Portal user credentials are required to generate an access token to query the iRP Deeplink endpoint within production, these user accounts are created by the PSAP administrators. When building and testing your integration with our Sandbox environment, you can create RapidSOS Portal users for testing within your provided RapidSOS Portal Sandbox account.

This can be created through the admin panel using the add user feature:

  1. Enter the email address and Password > Press Login

  2. Select > Admin

  3. Select > Users tab

  4. Select > Add User

  5. Fill out the required information (first name, last name, email, role) and press > SAVE

[INCLUDE IMAGE]

Authentication Token Creation

Credentials of users with both administrator roles and non-administrator roles can be used to generate auth tokens for use with requesting a RapidSOS Portal Deeplink URL.

Response of a Request

The response of the request will contain a Deeplink URL. This URL will automatically populate the user’s session and search for the 9-1-1 call or Alert specified in the query attribute of the request when opened in a browser.

Note: Integrated solutions can use this URL in an embedded web widget, but are recommended to use an OS system call to pop open the system’s default web browser for display (details of usage are up to the maintainers of each integrated solution).

IMPORTANT: The login session of this URL will be valid for 1 hour.

Implementation Flow

Additional Considerations

  • RSOS Portal is kept up to date with browser updates
  • If interested in using iRP through VPN, contact: [email protected]

Additional Reference