Developer Documentation

OptoSoft Retapos API

Programmatic access to your optical retail operations — customers, orders, quick sale, invoices and receipts — over a secure JSON REST API.

API Reference Authentication

Overview

The OptoSoft Retapos 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.

Base URL

https://app.opto-soft.com/global/api-v1

Auth & Format

JWT Bearer · application/json

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 interactive API reference.

Resource groups

Auth

Obtain and manage access tokens

Account

Signed-in user and profile details

Customer

Patient/customer records and eye info

Orders

Sales orders, status and advances

Quick Sale

Fast counter billing workflow

Invoice

Invoices and invoice lists

Receipts

Payment receipts

Dashboard

Store performance summaries

Common

Shared lookups and master data

Authentication

Log in and use JWT bearer tokens.

API Reference

Interactive endpoint explorer.

Errors & Conventions

Status codes, paging, versioning.
Chat with us
Call us