Forced Required to use in documentation, to get additional data about quote status: meta block from example with warnings, errors. Plan to make it as default behaviour.
Ledger/Sales service (1.0)
Using Swagger documentation in Postman
You can find instructions on how to convert swagger documentation to Postman collection here.
There is a known problem in Postman with env variables being imported as parameters (:schemaName instead of {{schemaName}}. More info on the issue can be found here.
Possible workaround is to find and replace all parameters with env variables inside Postman. For example search for :schemaName and replace with {{schemaName}}. Instructions how to do it in Postman are here.
Authorization
To obtain a token, start by visiting the identifier service documentation and make a request with your username and password.Once you receive the response, copy the
access_token and use it for making requests to ledger services.Download OpenAPI description
Languages
Servers
Mock server
https://ledger.docs.insly.com/_mock/apis/ledger/bundled/
Beta
https://ledger.app.beta.insly.training/
Demo
https://ledger.app.demo.insly.com/
- Mock server
https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/sales/policies/{policyId}
- Beta
https://ledger.app.beta.insly.training/api/v1/ledger/sales/policies/{policyId}
- Demo
https://ledger.app.demo.insly.com/api/v1/ledger/sales/policies/{policyId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/sales/policies/{policyId}?withNotifications=true' \
-H 'Accept-Language: string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'X-TENANT-ID: {$inputs.tenant}'Data block response structure per product can be taken from json scheme Product json scheme. with type: policy and name: {name of the insurance product}.
Path to json scheme used for validation. Sometimes required fields are removed based on business logic.
Error that can't be overcomed/retried in most of the cases. Connection time-out to integration, connection fail.
Error that can be handled manually by inserting data manually, edit the data, retry. Not blocking the flow. Vehicle make and model not found, insert it manually.
Response
application/json
The full data block structure per product can be taken from product json scheme with type: policy and name: {name of the insurance product}.
[ { "data": {} }, { "meta": null, "schemaPath": "policy/regular/{product}", "warnings": [ … ], "errors": [ … ] } ]
- Mock server
https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/sales/policies/actions/{id}
- Beta
https://ledger.app.beta.insly.training/api/v1/ledger/sales/policies/actions/{id}
- Demo
https://ledger.app.demo.insly.com/api/v1/ledger/sales/policies/actions/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/sales/policies/actions/{id}?longPolling=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'X-TENANT-ID: {$inputs.tenant}'Response
application/json
{ "data": [ "quote:download", "quote:update", "quote:copy", "quote:calculate", "quote:issue" ], "meta": [], "links": { "quote:changes": "https://app.beta.insly.training/api/v1/ledger/sales/policies/1/changes" } }
- Mock server
https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/sales/policies/{policyId}/installments-schedule
- Beta
https://ledger.app.beta.insly.training/api/v1/ledger/sales/policies/{policyId}/installments-schedule
- Demo
https://ledger.app.demo.insly.com/api/v1/ledger/sales/policies/{policyId}/installments-schedule
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://ledger.docs.insly.com/_mock/apis/ledger/bundled/api/v1/ledger/sales/policies/123/installments-schedule \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'X-TENANT-ID: {$inputs.tenant}'Response
application/json
{ "instalments": [ { … } ] }