OptoSoft Developers API

Overview

The OptoSoft Developers API is a JSON-over-HTTPS REST API that lets your systems read and write optical retail data — patients/customers, sales orders, quick-sale transactions, invoices and receipts. All requests are authenticated with a JSON Web Token (JWT) obtained from the login endpoint. API access is available to OptoSoft account holders; contact our team to enable it for your store.

Quickstart

1. 1

   Get an access token

   Exchange your OptoSoft credentials for a JWT.

   curl -X POST https://app.opto-soft.com/global/api-v1/api/Auth/login \
     -H "Content-Type: application/json" \
     -d '{"userName":"YOUR_USERNAME","password":"YOUR_PASSWORD"}'

2. 2

   Call an endpoint with the token

   Send the token in the Authorization header on every request.

   curl https://app.opto-soft.com/global/api-v1/api/Account/user-details \
     -H "Authorization: Bearer YOUR_JWT_TOKEN"

3. 3

   Explore the reference

   Browse every endpoint, request body and response schema in the API reference — or download the Postman collection and call the API straight away. The login request stores your token automatically, so every other request is authorised.

Postman collection

A ready-to-import Postman collection is generated from the same specification that powers the reference, so it always matches the live API. It ships one folder per resource group, 80 requests, example JSON bodies, and collection-level Bearer auth.

1. Download the collection and import it in Postman (Import → Files).
2. Open the collection's Variables tab and fill in userName and password.
3. Run POST /api/Auth/login — the JWT is stored in accessToken and every other request inherits it.

Resource groups