Skip to main content

SmartEPI External API

Integrate SmartEPI with your ERP, BI, or internal tooling. The API lets you:

  • Read organizational data — sectors, cost centers, job roles, groups, employees, products, and access groups (read-only).
  • Read transactional data — withdrawals, returns, exchanges (read-only; devices are their sole origin).
  • Write organizational data — create, update, and delete the org entities, with foreign-key validation.
  • Receive webhooks — real-time, HMAC-signed events for transactions.

Base URL & versioning​

The API is served per solution provider; your provider gives you the host:

https://{your-provider-host}/v1

The contract is versioned in the path (/v1). Within a version, changes are additive only — we never remove or repurpose a field you already depend on.

Data scope​

Every API key is bound to your organization. A key reads and writes only your own data — you never see or affect anyone else's. A write that references an ID your organization doesn't own is rejected (422).

Quick start​

  1. In the web console, go to Settings ▸ API Integration and create an API key. Copy the key immediately — it is shown only once.

  2. Call the API with the key as a bearer token:

    curl https://{your-provider-host}/v1/employees \
      -H "Authorization: Bearer sk_…"

  3. Optionally register a webhook endpoint (same console page) to receive real-time events.

Continue to Authentication for key handling.