Ir al contenido principal

Suprema CLUe API

28 endpoints — Select an endpoint from the sidebar.

All requests use the https://api.moon.supremainc.com/v1 and {{apiKey}} collection variables. Set {{apiKey}} to the API key issued from the CLUe Web Portal (Place Group → Settings → Admin → Manage API Keys); it is sent as a Bearer token via the collection-level Authorization setting, inherited by every request.

For more information on issuing CLUe API keys, see CLUe API Guide.

API Basics

Base URL: https://api.moon.supremainc.com/v1 — all requests must be made over HTTPS.

CLUe follows RESTful principles, using GET, POST, PATCH, and DELETE. Request and response bodies are JSON-encoded.

Success response: HTTP 200

field Desc Optional
code API Response Code
status API Response Status
message API Response Message true
data API Response Data true

Fail response: HTTP 400 / 500

field Desc Optional
errors API fail Response
errors.code Fail error code
errors.message Fail reference message
errors.details Fail details true

General Error Codes

code desc
e1000 Internal Server Error
e1001 Permission Denied
e1002 Not Supported
e1003 Invalid Format
e1004 Json Parse Error
e1005 Method Argument Not Valid
e1006 Bad Request
e1007 Resource Not Exists
e1008 Method Argument Type Mismatch
e1009 Missing Request Header
e1010 TooManyRequest

API Limit

CLUe has an API call traffic limit of 300 calls per 5 minutes per API, per source. For face enrollment specifically, add some sleep time between calls to account for template extraction and device sync.

Folders in this collection

  • User & Face Management — create users, enroll faces, and pre-check duplicate faces via device.
  • User & Card Management — enroll CSN/Wiegand cards, manage doors, and modify/delete auths.
  • Fingerprint Enrollment — enroll a fingerprint via device scan.
  • RF Card Enrollment — enroll an RF card via device scan.
  • Door Control — remote unlock/lock.
  • Device Display — device images and on-screen notifications.
  • Event Logs — retrieve access/device/place event logs.
  • Dynamic QR Code — generate/list/retrieve/delete CLUe dynamic QR codes for VENDOR-integrated access.