OptikamPad Integration

1) Verify OptikamPad Credentials  

To integrate with OptikamPad , first confirm whether the OptikamPad credentials have been added. To do this, navigate to the Settings menu.

2) Enable OptikamPad Integration  

Next, go to the Integration tab and locate the OptikamPad Integration settings. If the Enable OptikamPad Integration checkbox is unchecked, please check it.

After enabling the checkbox, you will see fields such as Username, Password, and API Key.

3) Configure Username, Password, and API Key

After that, enter a username in the Username field (you may create your own username).

Next, enter a password in the Password field (you may create your own password).

Then, click the Generate API Key button. The system will automatically generate an API key. Copy the generated API key and paste it into the API Key field and click on the save button .

Please refer to the screenshot below for guidance.

4)  Add Credentials to the Optikam Portal

Next, you need to add these credentials to the Optikam Portal.In the blue section above, you can see the steps explaining how to set up the Optikam Portal integration.

So for that,  Just Go to your Optikam Portal https://portal.optikam.com/ and login with your credentail  and navigate to: ACCOUNT → BRANDS → INTEGRATION and then

Select: Custom Integration

API Endpoints to configure:

• Client Search: https://yourdomain.com/api/optikam/clients/search
• Order List: https://yourdomain.com/api/optikam/orders/list
• Place Order: https://yourdomain.com/api/optikam/orders/create
• Associates: https://yourdomain.com/api/optikam/associates/list

Also, enter the same credentials that you created in our system.

Add the following details:

• Username
• Password
• API Key

Make sure to enable the Basic Auth option in the portal.

Please refer to the attached screenshot for guidance.

5) How to Verify an Updated Existing Order from Optikam

Next, call the configured domain endpoints from the Optikam App. Once the request is sent, you will receive a response from our system.

To verify an updated existing order from Optikam, follow these steps:

1. Copy the Sales Order Number (ID) from the Optikam App.

   You can obtain this from the following endpoint:

   https://yourdomain.com/api/optikam/orders/list

2. Go to the Sales Module in your system.
3. Remove the "My Quotations" filter.
4. Paste the copied Sales Order Number (ID) into the search bar.
5. Click Search to view the updated order details.

Please refer to the attached screenshot for guidance.

6) View and Open the Order

Once the order appears in the list view, locate it and simply open the order to view its details.

7) Verify Updated Fields from Optikam API

After opening the order, you will see fields highlighted in blue.

All blue-colored fields indicate data that has been updated from the Optikam API. You can review these fields to confirm the updates.

8) View Updated OptikamPad Measurement Details

After that, navigate to the Transmission Settings tab.

Here, you will find the OptikamPad Measurements Division. Click the Full Details button to view the complete list of updated values and other related information.

9) OptikamPad Measurements – Full Details

In this wizard, you will find all the measurement details. There are three tabs available:

1. Pupillary Distance & Heights
2. Frame Measurements
3. Notes & Images

You can review all the relevant details from these tabs to verify the measurement information.