Authorization management

Endpoints

Method	Endpoint
GET	https://app.insurehero.io/api/shield/v1/auth/authorize

Access token

Get an accessToken to start using the Shield API

Authorize channel to use API

GET https://app.insurehero.io/api/shield/v1/auth/authorize

You will need an authorization token to send requests to the integrations API.

Each token has a lifespan of 1 hour.

Headers

Name	Type	Description
x-api-key*	string	Your integrations api key

Example Response

200: OK Authorized

{
    data: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.."; // accessToken
}

400: Bad Request Missing x-api-key header

{
    "error": "Request contains malformed data",
    "details": "Bad Request Missing x-api-key header"
}

401: Unauthorized Invalid api key

{
    "error": "Invalid or expired access token",
    "details": "Invalid api key"
}

429: Too Many Requests API rate limit exceeded

{
    "error": "API ratelimit exceeded",
    "details": "Too Many Requests API rate limit exceeded"
}

402: Payment Required Pending payment

{
    "error": "Pending payment",
    "details": "Payment Required Pending payment"
}

Attributes

Name	Description
data	Access token used for authentication and API requests
x-api-key	A unique key assigned to each channel, used for authentication and authorization in API requests

Refresh access token

Each accessToken comes with a 1 hour lifespan. This means, you will need to check before each API call wether your accessToken is still valid.

• If the token is still valid: We recommend at least 5 minutes remaining. If it is valid, continue making request.

• If the token is expired or close to: We recommend if it has less than 5 minutes remaining or is already expired, then call the authorize endpoint to request a fresh accessToken.