Running your first test

Overview

This guide walks developers through the steps to successfully complete their first RapidSOS API requests

Pre-requisites

The developer must have completed the following items before making a request:

1. Your company has an active partnership with RapidSOS or is engaged with a RapidSOS Solution Engineer to discuss optimal workflows that could be most efficient for your company
2. Authorized credentials for the APIs tied to your workflows
3. Configured workflows/layers/schemas as required for your solution
4. Testing tools such as a RapidSOS Portal account

If you are missing any of the above, contact [email protected] or your RapidSOS Administrator

Country and Language Support

The Emergency Workflow API supports dispatch in the US, CA, MX, and UK for all solutions. Support for other countries may vary by solution type.

The Emergency Workflow API supports English, Spanish, and French. Support for other languages can be handled on a case-by-case basis.

Video Support

Making the request

Using the authorized credentials and configured workflows/layers/schemas provided by RapidSOS:

1. If required for your solution, generate an authentication token using the relevant path for your API - usually POST /oauth/token
2. Choose your API and follow the OpenAPI spec schema, code samples, and other documentation provided:
   • Emergency Workflow
   • Account Registry
   • Map Layers (Static & Dynamic)
   • Resource Manager (multimedia)
   • App Launcher
   • Data Share

Considerations for the Workflow API

Event Updates

The Emergency Workflow API supports real-time updates from partners for:

• Emergency location updates
• Additional event context (supplemental data) such as user notes, images and video
• Canceled requests for help

While these actions are supported via the Workflow API, they utilize different workflows. Examples can be found in this specification POST Triggers a RapidSOS workflow.

Verifying the request

Assuming the expected 2xx response is returned for your API request, you have verified the connectivity with RapidSOS. Congratulations!

However, a successful API request is only part of verifying the full scope of the RapidSOS Intelligent Safety Platform. In addition to the documentation in this Developer Portal, you can verify the solution behavior using:

1. The RapidSOS Portal Account provided to you by RapidSOS
2. The server you configure to receive and process RapidSOS webhooks

Support

If you are having trouble with your request, contact [email protected] or your RapidSOS Administrator