Claims BI API
1. Overview
Jakamo is a great tool for handling claims and sharing them with suppliers. Claims can be created in Jakamo UI or REST API integration. A claim item in Jakamo contains information about the actual claim but also about the supplier's response to a claim.
This article focuses on the JSON-based REST API over HTTPS for retrieving claims information to be used in external systems (BI reporting etc). Claims BI API has a GET endpoint for retrieving claims data from Jakamo. Claims BI API support for getting incremental data as a default. The possibility also to fetch all the data.
Request demo accounts from Jakamo Support Team (support@thejakamo.com) to create a Claims BI integration from your system to Jakamo.
There are two similar Jakamo environments available for you: the test (=demo) environment and the production environment.
- Test environment is for testing purposes. Start your integration testing and user training in a test environment.
- Production environment is for the live use with other Jakamo companies.
2. Authorization
Jakamo Claims BI API uses OAuth2.0 or basic authentication as an authentication method. OAuth2.0 is the preferred method. Find step-by-step instructions on how to move from basic authentication to use OAuth2.0.
For basic authentication, the username and password for the API are set inside the Jakamo account in the Integrations settings with the CHANGE CREDENTIALS functionality. If you have multiple integrations enabled towards your Jakamo company account, please use different credentials for each integration.
3. Claims BI API endpoints
| Jakamo environment | HTTP request | Jakamo API endpoint |
|---|---|---|
| Test environment | GET | https://demo.thejakamo.com/api/claims |
| Production environment | GET | https://www.thejakamo.com/api/claim |
4. Example requests
Supported query parameters:
- (string) type: sent|received
- default: received
- fetch either sent or received claims
- (boolean) all: true|false
- default: false
- fetch all claims instead of default incremental behavior
An example request on fetching all sent claims:
HTTP GET https://demo.thejakamo.com/api/claims?type=sent&all=true
5. Handling incoming message queue
See the general Jakamo API queue handling instructions from incoming message queue handling page. Jakamo stores all outgoing messages in an API queue. By making an HTTP GET request to the response endpoint Jakamo delivers the first message from the queue.
Messages in the response queue must be cleared after they have been processed. The response message contains an x-acknowledge-uri header. Posting to this URI removes that message from the queue. After that, the next message from the queue will be returned.
6. Request response messages
The table below presents the most common API request responses from Jakamo RFQ API.
| HTTP response status code | Response body | Additional information |
|---|---|---|
| 200 OK | Claims data message | Claims data successfully retrieved from the Claims BI API. |
7. Steps to go to production
Contact Jakamo Support Team (support@thejakamo.com) to enable the Claims BI API in Jakamo. Once the integration is activated to your production account by Jakamo staff, you can define API authentication method on the Integrations page found from Jakamo's upper-left hidden menu. After that, you can retrieve claims data from your Jakamo company account.
Didn't you find what you were looking for? Send an email to Jakamo support (support@thejakamo.com) and we will help you.