canonical: https://jentic.com/apis/smart-me.com/smart-me

# smart-me

With the smart-me REST API you get Access to all your devices in the smart-me Cloud and you can add your own devices. So its an easy way to add the smart-me Cloud support to your Hardware or Software Product. The API exposes 64 endpoints secured with basic authentication.

## For AI agents

Programmatically creates a access token to write on a card (e.g. nfc), post-api-account-login. Covers 64 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for iot and hardware only.

## Capabilities

- Creates a Access Token to write on a Card (e.g. NFC)
- post-api-account-login
- Account_Login
- Set an action for the specified device.
- Gets all available Actions of a Device

## Use cases

### IoT and Hardware Operations

Use the smart-me to perform iot operations programmatically. The API provides 64 endpoints covering core functionality including creates a access token to write on a card (e.g. nfc), post-api-account-login, account_login.

Example prompt: Call PUT `/api/AccessToken` to creates a access token to write on a card (e.g. nfc)

### Automated AccessToken Management

Automate accesstoken operations by combining multiple smart-me endpoints. Agents can post-api-account-login and then account_login in a single workflow.

Example prompt: Call POST `/api/Account/login` to post-api-account-login, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call smart-me endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'creates a access token to write on a card (e.g. nfc)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| PUT | `/api/AccessToken` | Creates a Access Token to write on a Card (e.g. NFC) |
| POST | `/api/Account/login` | post-api-account-login |
| GET | `/api/Account/login` | Account_Login |
| POST | `/api/Actions` | Set an action for the specified device. |
| GET | `/api/Actions/{id}` | Gets all available Actions of a Device |
| GET | `/api/AdditionalDeviceInformation/{id}` | Gets the additional information (e.g. Firmware Version) about a device. |
| POST | `/api/CustomDevice` | Creates or updates a Custom Device or updates it's values. |
| GET | `/api/CustomDevice` | Gets all Custom Devices |

## Key resources

- **AccessToken** — Operations related to AccessToken
- **Account** — Operations related to Account
- **Actions** — Operations related to Actions
- **AdditionalDeviceInformation** — Operations related to AdditionalDeviceInformation
- **CustomDevice** — Operations related to CustomDevice

## Why Jentic

- **Setup:** Wiring smart-me by hand means handling its basic auth against smart-me.com, tracking device and action ids, and managing retries yourself. Through Jentic you install once, import smart-me from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** smart-me puts the resource id in the URL path (`/api/Actions/{id}`, `/api/AdditionalDeviceInformation/{id}`), so a rule can pin your agent to one device or action: it can read that resource and nothing else. You choose the operations it may call, so writes like creating a custom device are not included unless you add them.
- **Credential handling:** Your smart-me credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'read a device's values' or 'trigger a device action', and Jentic returns the matching smart-me operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Particle** — Alternative iot API
- **Stripe** — Complementary API for broader integration workflows
- **Twilio** — Complementary API for broader integration workflows

## FAQ

### What authentication does the smart-me use?

The smart-me uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I creates a access token to write on a card (e.g. nfc) with the smart-me?

Yes. Use the PUT `/api/AccessToken` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the smart-me?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I creates a access token to write on a card (e.g. nfc) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'creates a access token to write on a card (e.g. nfc)'. Jentic returns the matching smart-me operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the smart-me have?

The smart-me exposes 64 endpoints covering accesstoken, account, actions operations.

### Can I limit what my agent is allowed to do with the smart-me API?

Yes. Because you run Jentic One yourself, your own rules decide which smart-me operations and credentials the agent may use. Since smart-me puts the resource id in the URL path, such as `/api/Actions/{id}` and `/api/AdditionalDeviceInformation/{id}`, you can pin the agent to a single device or action so it reads that resource and nothing else. You also choose the operations it may call, so writes like creating or updating a custom device via POST `/api/CustomDevice` stay off unless you add them.