Getting Started
Welcome to the Theft Report API integration guide. This guide will help you get started with the process of integrating your Internet of Things (IoT) GPS trackers with G4S’s vehicle recovery services. Follow these steps to begin using the Theft Report API and report stolen vehicles to G4S for recovery.
Prerequisites
Section titled “Prerequisites”Before integrating with the Theft Report API, ensure that you meet the following prerequisites:
-
Specify tracker capabilities
To use the Theft Report API, you need to first provide information about the localization capabilities your trackers support.The supported localization methods include:
- GPS
- WiFi
- Bluetooth Low Energy (BLE)
- LoRa
- GSM Cell Tower
-
Review API Documentation
Ensure that your telemetry data is compatible with the requirements specified in the Theft Report API documentation. Lookup the endpoint for publishing telemetry and check the Request Body for more information This includes:
- Sending real-time location data.
- Telemetry information required to track the vehicle.
- Reporting updates in the specified format. Lookup the endpoint for publishing telemetry and check the Request Body for details.
- Receive credentials
After reviewing your localization capabilities and telemetry compatibility, you will receive the necessary API credentials.
To Start Using the API
Section titled “To Start Using the API”Once you have received the necessary credentials, follow the steps below to start integrating and using the Theft Report API.
Step 1: Obtain API Credentials
Section titled “Step 1: Obtain API Credentials”You will receive two sets of API credentials: one for testing (staging) and one for the live (production) environment.
Your API credentials will include:
- Client ID: Your unique identifier as a third-party provider.
- Client Secret: Used to authenticate your requests.
Make sure to store these credentials securely.
These credentials should be sent in each API request as a Basic auth header with the Client ID as user-id and the Client Secret as password. (more info on Basic Auth)
Step 2: Test on our staging environment
Section titled “Step 2: Test on our staging environment”Each API endpoint in our documentation has a staging and a production endpoint URL. Using the Staging URL will not start an official recovery procedure and can be used for developing.
Step 3: Notify us when you’re ready to go live
Section titled “Step 3: Notify us when you’re ready to go live”Once you are ready to start using the production environment, let us know in advance so we can agree upon a date to put your integration to use.