Overview

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: You must have an active subscription before your API key can be used. Without a subscription, API calls will return 402. See (Rates & Availability API) for details.

1. Getting Your API Key

There are two ways to obtain your API key. Both require an active subscription first.

Option A: From the Developer Portal (Recommended)

Subscribe to a plan (Developer plan is free)

Go to Account & API Key and copy your API key

Call the login endpoint with your Sifely account credentials:

Method: POST
Path: https://cus-openapi.sifely.com/system/smart/login
Headers: Content-Type: application/json

Request Body

{
  "account": "your-email@example.com",
  "password": "md5-hashed-password"
}

Response Example

{
  "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.

Curl Example

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-token

Example Request

POST /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

Rate Limit Headers

All error responses include the following headers for tracking your limits:

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset

1. Getting Your API Key#

Option A: From the Developer Portal (Recommended)#

Option B: Via the Login API#

2. Using Your API Key#

3. Rotating Your API Key#

4. Error Codes#

1. Getting Your API Key

Option A: From the Developer Portal (Recommended)

Option B: Via the Login API

2. Using Your API Key

3. Rotating Your API Key

4. Error Codes