About oLocker API

Welcome to oLocker's API ! The primary reason you're here is to understand the purpose & usage of the provided API calls so that the data stored in your software/application can be exchanged with oLocker to provide Insurance cover to end-customers.

Your customer's (our friendly jewellery retailer's) have chosen us to extend Insurance & other host of services to their customer's. Let us assure you that we are not competitors, we are your friend and in time you'll see. With this collaboration we hope to make this partnership mutually beneficial.

Coming back, while the purpose of this API is primarily to enable seamless data exchange between your software/application with our platform oLocker.in to issue "Certificate of Insurance" to end-customer for every piece of jewellery he/she purchases. This is achieved by exchanging data via this Web API & JSON (JavaScript Object Notation).

Process/Steps

The entire process of exchanging data relevant for generating/issuing a "Certificate of Insurance" for an Ornament/Jewellery purchased can be achieved in 5 simple steps :

1. Authentication

Send the KEY/VALUE Hash pair and receive a Token Value.
Refer this link for more details.

2. Submit Ornament/Jewellery details

Send the Ornament/Jewellery details, this in turn generates an OID or Ornament ID inside oLocker databases. Each OID or Ornament ID is an Unique 16 character AlphaNumeric code. OID or Ornament ID is essential for Ornament/Jewellery identification (along with these details submitted) for processing/issuing cover.
Refer this link for more details.

3. Submit Ornament/Jewellery Image/Photo

Send the Ornament/Jewellery image/photo for photographic identification of the Ornament/Jewellery. The image/photo submitted is essential and is also printed in the "Certificate of Insurance".
Refer this link for more details.

4. Submit Ornament/Jewellery Invoice

Send a copy of the Retailer's Invoice in Image/PDF format of the Ornament/Jewellery being insured. This helps speed up the "Claim" process in case of any unfortunate event. Note : It is expected (if possible) that the Retailer's Invoice copy shows the generated OID or Ornament ID against the Ornament/Jewellery being insured.
Refer this link for more details.

5. Get "Certificate of Insurance"

Returns the "Certificate of Insurance" link/URL of the insured Ornament/Jewellery. This document is in PDF format and the retailer is expected to "Print" and hand over the document to the end-customer.
Refer this link for more details.

Note :: It is essential to ease the process of Insurance generation while Invoicing, we recommed that the process of generating insurance is easy for the POS operator. Proposed solution to many integrators : While the operator is on the final screen (just before printing the Invoice copy), a list items being invoiced could be display with a Checkbox next to it - indicating if the Insurance needs to be generated for that specific item, selected/checked checkboxs details will be sent to oLocker for insurance and the along with the Invoice the "Certificate of Insurance" can be printed for the end-customer.

Other Tools/Links for Help

1. JSON Validation

JSONLint is a validator and reformatter for JSON, a lightweight data-interchange format. Copy and paste, directly type, or input a URL in the editor above and let JSONLint tidy and validate your JSON code.
Refer JSONlint.com for more details.

2. API Tester

A powerful GUI platform. Postman helps you be more efficient while working with APIs. Using Postman, you can construct complex HTTP requests quickly, organize them in collections and much more.
Refer getPOSTMAN.com for more details.