Migrating from the legacy API (app-smart-manager.sifely.com)? See (Legacy API).
Sifely Public API uses API Key authentication. All API requests (except login) must include your API key in the Authorization header.Prerequisite: The lock owner must have an active subscription. Authorized users calling these operations with their own API keys do not need a separate subscription; metered usage counts toward the lock owner's account. Without an active subscription on the owner, API calls will return 402. See (Rates & Availability API) for details.
This API is designed for individual developers and businesses building integrations for locks owned by their own Sifely account (Super Admin). Authorized users, including eKey recipients, can also access those locks using their own API keys, subject to their permissions.If you are a partner or intermediary platform that manages locks across multiple separate customer accounts, this API is not the right fit. Please contact us to receive the dedicated Partner API documentation.1. Getting Your API Key#
Any Sifely account can obtain an API key by logging in to the Developer Portal or using the Login API below. API requests require an active subscription on the lock owner’s account. Authorized users, including eKey recipients, can make requests using their own API keys without a separate subscription. Their API usage counts toward the lock owner’s account.Option A: From the Developer Portal (Recommended for lock owners)#
2.
Subscribe to a plan (Developer plan is free)
3.
Go to Account & API Key and copy your API key
Option B: Via the Login API ((Recommended for eKey Recipients))#
Call the login endpoint with the account credentials to receive that account's API key.Method: POST
Path: https://cus-openapi.sifely.com/system/smart/login
Headers: Content-Type: application/json{
"account": "your-email@example.com",
"password": "md5-hashed-password"
}
{
"code": 200,
"data": {
"clientToken": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"clientId": "cli_xxxxxxxx",
"account": "your-email@example.com",
"plan": "DEVELOPER"
}
}
The clientToken (prefixed with sk-) is your API key. Store it securely — it does not expire unless you manually rotate it.
2. Using Your API Key#
Include the API key directly in the Authorization header for all subsequent requests:⚠️ Note: Do not use the Bearer prefix. Send the raw sk-xxx key directly.
3. Rotating Your API Key#
If your key is compromised, call the roll-token endpoint to generate a new one. The old key is immediately invalidated.Method: POST
Path: /client/roll-tokenPOST /client/roll-token
Authorization: sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
4. Error Codes#
| HTTP Status | Meaning |
|---|
| 401 | Invalid or missing API key |
| 402 | Subscription inactive (cancelled / expired) |
| 429 | Rate limit or quota exceeded |
All error responses include the following headers for tracking your limits:
Modified at 2026-11-19 09:08:39