Redkik 3 Embedded Insurance Software User Guide

Redkik 3 Embedded Insurance Software

Specifications

• Product Name : Redkik 3.0
• Authentication : OAuth 2.0
• API Endpoint : https://staging.app.redkik.com/api/v2/

Concepts

A Booking in Redkik represents coverage of a specific shipment. The lifecycle of a booking includes Setup, Quote, Purchase, Cancel, or Complete actions.

API Tokens

Redkik leverages OAuth 2.0 for authentication. API Tokens consist of a client_id and a secret_id keypair. To generate API Tokens, browse to Organizations, select your organization, and create a new API Token. Save the client_id and secret_id for future use.

Utilizing the Token and Listing Bookings

To list all bookings, use the provided access token in the Authorization header when making a GET request to the endpoint:

curl -X 'GET' 'https://staging.app.redkik.com/api/v2/quote/bookings' -H 'accept: application/json' -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Generate a Quote and Purchasing It

Before generating a quote, retrieve setup information from the /quotes/setup endpoint. To create a quote, submit a JSON structure to the /Bookings/quote endpoint.

FAQ

• How do I refresh an access token?
• To refresh an access token, use the refresh token provided when generating the initial access token. Make a request to the token endpoint with the refresh token to obtain a new access token.
• What is the lifespan of an access token?
• The access token has a limited lifespan for security reasons. It is recommended to refresh the token before it expires to maintain continuous access to the API.

Redkik 3 API usage
Oct, 2023: Updated for Redkik 3.0

Introduction

Redkik has launched its third iteration of the Redkik platform, appropriately known as Redkik 3.0. This guide quickly walks through the basic concepts and basic actions available through the Redkik RESTful API and common patterns.
Concepts
Bookings
A Booking represents coverage of a specific shipment. The steps of creating a quote and then purchasing it are simple:

1. Generat
2. Fields
3. Commodity information
4. Journey information
5. Cargo Owner information
6. retain the ID of the quote, returned with a successful quote
7. then use that ID to purchase the offer, which creates a booking. The Lifecycle of a Booking is:
8. Setup
9. Quote
10. Purchase
11. Cancel, or
12. Complete

API Tokens

Redkik leverages OAUTH 2.0 for authentication strategies. To learn more about oAuth2, please go to:

OAuth 2.0 — OAuth

The authentication flow is as follows

1. Generate API Tokens for an organization, typically Redkik’s job.
2. Generate a one-time, limited-lifespan access token for endpoint access
3. Refresh Access Tokens for continued use of that authentication session

Generate API Tokens
API Tokens are generated for an organization, consisting of a client_id and a secret_id keypair, and are used to generate one-time access tokens with a limited time-to-live. Browse to Organizations, select your organization (or a child-org if creating a Quote “On Behalf Of” that child-org), right-click on the org’s config button, and select API Tokens:

Upon Submission, you will have access to the client_id and the secret_id. Please ensure you save these off as this will be the only time you have access to them

Test it out in Swagger, using the /oauth/token endpoint:

Producing an Access token and Refresh token

Refresh Tokens

When API Tokens are used to generate an access token, they will also include a refresh token. This refresh token can be used to generate a new access token before the TTL of that access token expires, in order to keep that particular session alive. If the access token expires before it can be refreshed, the client_id and secret_id must be used again to generate a new access token.

Utilizing the token and Listing Bookings
To GET bookings using the token: e.g.: Authorization: Bearer For example, when using curl, one would need to include the token as a header specified on the command line

https://staging.app.redkik.com/api/v2/quote/bookings

Listing All Bookings

Listing a single Booking’s detailed information

Generate a Quote and Purchasing it

Getting Setup Information Before Generating a Quote
Optionally, we pre-populate a JSON structure with setup information around the policy context, available commodities, etc, which can help populate any UI forms upstream. This is not a required step, but it assists in setting the correct UUIDs for commodities and sundry. That endpoint is here: /quotes/setup

Creating a Quote

To create a quote, one must POST the following JSON structure to the /Bookings/quote endpoint (this is in its most basic form): /quote/quotes/quote:

Purchasing the Quote
To purchase the quote, one retains the ID (64-bit UUID) returned with the quote (in bold) and submits to the /purchase endpoint.

Cancelling the Quote
To cancel a booking, use the /cancel endpoint Advanced Quoting Quoting from multiple policies
Finding Policy IDs
Some organizations have multiple policies from which they may quote. In those instances, the policies are listed in the /setup call.

Quoting on behalf of
To create a booking on behalf of a child org, simply pass that child org’s id with the quote: “orgId”: “cf417c93-8486-4c28-89c6-effa05987e67”

Obtaining the Certificate of Insurance

• TBD
• Referrals
• TBD
• Referring a Booking
• Listing Referred Bookings
• Accepting a Referred Booking (Underwriter)
• Purchasing a Referred Booking (Customer)

API Swimlane

References

• staging.app.redkik.com/v1/quote/bookings/purchase

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>