Ignite Signals API Package
Best-in-class telemetry collection for Brokers and Insurers
Explore the docs »
Open Portal
Getting Started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
Install package
- Install
# Using pnpm
pnpm add -D @ignite-signals/api
# Using yarn
yarn add --dev @ignite-signals/api
# Using npm
npm install --save-dev @ignite-signals/api- Create your client
import { createClient } from '@ignite-signals/api'
const igniteSignalsClient = createClient('YOUR_API_KEY')- Start using Ignite Signals! For example here we are checking if a vehicle is compatible with the service
try {
const vehicle = igniteSignalsClient.compatibility.checkVehicleCompatibility.query({
abiCode: '000000',
})
if (vehicle.compatible)
console.log('wahooo 🎉')
}
catch (error) {
console.log(`error - ${error.code} ${error.message}`)
}- Refer to the documentation for more help