A8PRO CR · Local API · Windows
Connect A8PRO CR to your software
Read documents locally using a compatible card reader or passport scanner. Find the integration workflow, API commands and developer kit here.
Russian technical guide, OpenAPI, Postman, 1C template and synthetic JSON examples. No installer or credentials.
Contract for release 1.1.30.0 Universal R4. Verify your app version, driver and device before deployment. Frozen sources and package identity were checked; physical hardware and your 1C configuration require separate acceptance testing.
Prepare the workstation
- Agree the A8PRO CR release, Windows version, driver, device and document types.
- Obtain the installer from A8PRO. Before updating, close the app through its tray menu and use the same Windows account; do not uninstall the previous version first.
- Check the licence, CHIP/MRZ permissions and the local service on port 9010.
- Set A8PRO_API_TOKEN in the app environment: a random secret of at least 32 characters. Send it in X-A8PRO-Token. The app reads it at startup.
Send requests from the reader's computer
Base URL: http://localhost:9010. Use /v2/ for new integrations. An installed 1C client calls this address on the workstation. A server-side call reaches the server itself, not the operator's PC. Browser CRM and terminal deployments need a separately agreed architecture; arbitrary website origins are restricted.
http://localhost:9010X-A8PRO-Token: <local-secret>
Four API commands
GET /v2/status
CHIP presence and feature permissions. A 200 response does not prove MRZ hardware readiness.
GET /v2/getInfo
A fresh read. HTTP 200 returns fields or status=waiting. Keep scanId from the response header.
GET /v2/getInfo/last
Latest result wrapped in scanId / scannedAt / source / data. HTTP 204 means no result.
POST /v2/getInfo/ack?scanId=…
Clear the accepted result from local cache. Success: empty 204. A repeated ACK may return 404.
Receive, review, save — then acknowledge
- Start one read at the operator's request. CHIP has priority; MRZ is used when no card is present and the feature is permitted.
- Display fields for review. HTTP 200 with status=waiting is not a successful document read.
- Save in your software, preventing duplicate records for the same scanId.
- Only after confirmed durable storage, ACK the same scanId. Displaying a result is not storage confirmation.
The local server has one latest-result slot. A new scan replaces it. /last has a two-minute lifetime checked on access, not a guaranteed memory-erasure timer. Never fill a new client record from /last without matching a known scanId. Repeating /getInfo starts another read; it is not idempotent.
Fields and formats
Names: lname, fname, sname; document: docType, docnum; IIN: iin; issuer: issuer; dates: bdate, valid_from, valid_to; citizenship: citizen; issuing country: issuecountry; sex: sex; birthplace: bplace; nationality: nation; MRZ names: mrzln, mrzfn. Values are strings and may be empty. Dates are generally DD.MM.YYYY and need validation. photo and sig_photo are empty in the checked release paths. Field names differ from QRScan.
Handle waiting and errors
Check HTTP status before JSON: 204 has no body. 401: token; 403: licence or local-access restrictions; 429: busy; 503: timeout, device or shutdown; 500: internal error. Error bodies may be empty. The read budget is 10 seconds; allow a client timeout margin, for example 15 seconds. Avoid concurrent retries.
Developer resources
The 1C template targets an installed Windows client and needs configuration-specific adaptation. It does not write business records or ACK automatically. It has not been executed in a real 1C database or with physical hardware.
Before workstation deployment
- Test agreed document types separately for CHIP and MRZ, including fields, dates and encoding.
- Test waiting, lost responses, busy state, device disconnection and licence restrictions.
- Test save-before-ACK, repeated ACK and protection against using a previous client's result.
- Record the release, hardware, receiving system and pilot results.
Tell us your software, client execution location, Windows version and reader model. We will agree the solution and interface for the selected release.