Integration Requirements and Recommendations Overview
This page provides information about how to best integrate with RapidSOS. The following information describes specific requirements, recommendations, and best practices that should be reviewed.
Requirements for Integration
- Data is provided to the 9-1-1 entity answering the call only (it is not to be used by integration partners for commercial or other purposes).
- Every 9-1-1 entity needs to have unique access credentials to the RapidSOS system. Each agency agrees to the licensing agreement for each integration credential they request. RapidSOS manages this process.
- As of 2/20/2020, Credential management is all handled through the administrative module within RapidSOS Portal.
- Integration partners do not have access to the production environment. Integration partners have access to testing/development only on the RapidSOS Sandbox or pre-production environment.
- Data needs to be displayed as supplemental data (i.e., in addition to regulated data, not replacing regulated data). RapidSOS data should never replace FCC-regulated data.
- When connecting to the Emergency Response Data Platform connection, you must use TLS v1.2 or higher.
- Querying every call is Required. Integrations should not parse for wireless, by the carrier, or otherwise exclude calls that are queried.
- Querying automatically is Required. Data should be queried automatically, and not require interaction by the user to invoke the initial query process.
- RapidSOS location data should not update call for service location automatically. A mechanism to update the service location programmatically (e.g., push a button) with the RapidSOS data should be provided so end users can make this decision and quickly update the call record if they choose.
- Show X, Y coordinates in a text format
- Show location on the map (when a map is included in the solution) using icons that differentiate ALI vs. RapidSOS location
- There are RapidSOS Branding assets that may be used here.
- Include the circle of confidence or certainty radius as a text field if preferred.
- Clearly label the RapidSOS location separate from the ALI Location. It is recommended to use the RapidSOS logo found within the RapidSOS Branding Assets section of this dev portal.
- Show the relationship to the ALI data (e.g., as overlays on the same screen with a line drawn between ALI and RapidSOS location)
- Include additional data (not only location), either via an API integration or by integrating RapidSOS Portal.
Integration Best Practices
These are some best practices to consider when developing an integration between the RapidSOS Emergency Response Data Platform and your product. Our intention is not to tell you what to do with your product, but to share what we have learned after working with many partners on integrations, and closely with more than 4700 911 agencies on a daily basis. Our goal is to ensure the highest level of customer satisfaction for all of us. We are also happy to discuss this with you as you plan out your integration design.
- Show location on a map with uncertainty radius, and as text with additional information (e.g., timestamp, lat/long, altitude, etc.). Design the display such that it is easy to relate the location data from different sources (e.g., overlays, side by side, etc.). NOTE: As of September 2018, this is a requirement for new integrations, as noted above. Existing integrations should add this capability in their next development cycle. Icons should clearly differentiate ALI and RapidSOS location.
- Show location as x/y/z with the ability to reverse-geocode using authoritative ECC data.
- Reverse geocoding is not provided by RapidSOS and would need to be built into an integration separately.
- Show breadcrumb trail when the caller is moving
- Enable a “toggle” function to turn off the circle and/or breadcrumbs if they are interfering with the screen view
- Enable the location to be stored as part of the call/incident record.
- Enable the location to be pushed to third-party applications (e.g., Map, CAD, Responder app, recording, etc.)
- Query location and additional data periodically throughout the call (typical interval would be every 7-10 seconds). More sophisticated integrations vary the query interval based on the source of the data and the time since the data has changed. This is important if a caller is moving or additional data becomes available and increases in importance as more data sets are added to the RapidSOS Emergency Response Data Platform.
- Building on the above, allow users to “breadcrumb” locations without cluttering the main map interface (enabling users to “toggle” breadcrumbs on/off is a great way to manage this). It’s important to see where a caller is moving, but this should not interfere with other important data.
- Show additional data (i.e., from the additional data API or integrated RapidSOS Portal) in a separate tab where it doesn’t distract the user when irrelevant. However, provide some indicator on the main screen that additional data is available. Examples could be when hovered over, or “lighting up” the icon in a different color, or some other appropriate indicator that is informative but not distracting.
- Allow for the Telecommunicator to copy the location and additional data that is in a text format to be pasted or entered in their CAD incident, if there is not a mechanism to do so automatically.
- If this is a CAD integration, allow the Telecommunicator to use RapidSOS location to update the event location by a simple button click.
- CAD Integration: For optimal user experience, consider providing a method for data such as vehicle license plate to be parsed to fields in CAD that would perform an automatic query against a state system or NCIC to quickly check for any “hits.”