--- SERVICES BY E-OSCAR® · DEVELOPER TECHNICAL GUIDE
Build the integration.
Ship it right, the first time.
For technical leads, integration developers, and middleware vendor implementers. This guide covers credentials, call sequences, testing, and troubleshooting.
⚠ Two things to know before you write a single line of code
(1) Once an API user is created in the e-OSCAR UI, you have 24 hours to call /changePwd via the API. Miss this window and the account locks permanently until reset.
(2) Do NOT call /authRequest before every API call. Call it once per session, store the token, and reuse it. Repeated calls within the validity window return errors — not new tokens.
--- OVERVIEW
What you are building
Services by e-OSCAR is a REST API that mirrors the transaction surface of the e-OSCAR interactive application. You are building a client that authenticates, finds work to do, retrieves transaction detail, and submits responses — all without anyone logging into the UI.
API user roles
Each API operator is assigned exactly one role. You cannot mix roles on a single operator.
--- AUTHENTICATION
The credential lifecycle
Authentication for Services by e-OSCAR is different from the interactive application. Every step is mandatory and must complete in order. This is the single most common source of support tickets.
Password reset procedure
To rotate or reset an API Operator's password: log in as Operator Admin → Operator Management → click the magnifying-glass icon next to the operator (this generates a new Temporary Password). Capture it. Then call /changePwd via the API within 24 hours — same rules as initial setup apply.
--- ACDV PROCESSING
ACDV workflow — required call sequence
The call sequence is strictly ordered. Skipping a step causes submission failures — most commonly, skipping /view and going straight from /find to /submit, which leaves the ACDV in PENDING-SENDREQUEST status and causes /submit to be rejected.
--- REFERENCE
Base URLs & environment reference
--- TESTING
Testing with Postman
Postman (or any comparable API client) is the recommended first step when you encounter an unexpected API error. Testing in a neutral application isolates whether the issue is in your internal build or the API service itself.
--- TROUBLESHOOTING
Common errors and resolutions
Most inbound API tickets fall into one of these categories. Check here before opening a ticket.
Pre-ticket checklist
Complete every item before opening a ticket. This resolves the majority of issues without OLDE involvement.
--- SUPPORT
Opening a support ticket
If the pre-ticket checklist doesn't resolve the issue, open a ticket at eoscarsupport.bolddesk.com.
Include the following in every ticket:
-
Your Registration ID.
-
The full endpoint URL you are calling.
-
The request body (screenshot from Postman or similar — with all PII redacted).
-
The complete error message or response you received.
-
Which environment you are working in (Stage or Production).
-
Steps you have already taken to troubleshoot.
--- GET HELP