Skip to content

Zimark Integration API (v1)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server

https://docs.zimark.link/_mock/api/

https://api.zimark-staging.link/

https://api.zimark.link/

User

Operations

Manifest

Operations

Track

Operations

Printing Batch

Operations

Calibration Integration

Operations

Download calibration file (external)

Request

Retrieve calibration file content. Requires X-Auth-Token header with CAMERA_READ scope.

Path
hardwareIdstringrequired

Camera hardware identifier

Example: CAM-001
typestringrequired

Calibration type

Enum"INTRINSIC""GATE"
Example: INTRINSIC
curl -i -X GET \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/camera/CAM-001/calibration/INTRINSIC

Responses

Calibration file content

Bodyapplication/json
Response
application/json
null

Upload calibration file (external)

Request

Upload or overwrite a calibration file. Requires X-Auth-Token header with CAMERA_WRITE scope. Returns 201 for new uploads, 200 for overwrites.

Path
hardwareIdstringrequired

Camera hardware identifier

Example: CAM-001
typestringrequired

Calibration type

Enum"INTRINSIC""GATE"
Example: INTRINSIC
Bodyapplication/jsonrequired

Raw JSON calibration file content

string
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/camera/CAM-001/calibration/INTRINSIC \
  -H 'Content-Type: application/json'

Responses

Calibration overwritten successfully

Body*/*
cameraIdstring
typestring
checksumSha256string
messagestring

Delete calibration file (external)

Request

Delete calibration file. Requires X-Auth-Token header with CAMERA_WRITE scope.

Path
hardwareIdstringrequired

Camera hardware identifier

Example: CAM-001
typestringrequired

Calibration type

Enum"INTRINSIC""GATE"
Example: INTRINSIC
curl -i -X DELETE \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/camera/CAM-001/calibration/INTRINSIC

Responses

Calibration deleted successfully

Body*/*
cameraIdstring
typestring
checksumSha256string
messagestring

Scanner

Operations

Local Manager

Operations

Gate

Operations

Audit Log

Operations

Alert Events

Operations

Agent

Operations
Copyright 2025 Zimark Inc © All rights reserved.