Files
dashback/docs/api/routes/pos/client.md
2026-09-29 11:31:35 +02:00

47 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# `GET /v1/client`
Public. No cookie required.
POS discovery and pairing
Special API for POS bind and sync.
- Step 1 (Discovery): `authCode` length 1–4. Returns certificate fingerprints, serial number, and mandantId.
- Step 2 (Pairing): `authCode` length 6 (pairingpin from posterminal). Verifies the pairingpin, sets token, paired_at, and clientserial, revokes the pairingpin, and returns device credentials and company metadata.
## Query parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `authCode` | yes | string | Discovery code (1-4 digits) or pairing PIN (6 digits) |
| `name` | no | string | Client device name or serial identifier (default 'JTL-POS') |
## Response `200`
Discovery or pairing successful
```json
{
"authCode": "678677",
"authToken": "df40ad2067954646abb0499548a52241",
"certificateFingerprint": "30DD111E8048B57E6A4FB75AD7E63F7E657F1262",
"certificateSerialNumber": "1BB1BD7844451E3AC6",
"mandantId": "1",
"mandantName": "eB-Standard",
"mandantDatabase": "eazybusiness",
"serverFingerprint": "30-DD-11-1E-80-48-B5-7E-6A-4F-B7-5A-D7-E6-3F-7E-65-7F-12-62",
"name": "…",
"serverTimestamp": "2026-09-29 11:00:00"
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid or incorrect authentication code |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._