Send the administrator's or an authorized operator's API Key and a valid Secret Key to receive the `access_token`.
Smartbis Public API
Integrate sales, customers, coupons, and vouchers with the loyalty engine.
REST API v2 for server-to-server integrations with Bearer Token authentication, JSON communication, and endpoints to trigger rewards in real-time.
Basic flow
From authentication to automatic reward.
The main use of the API is to register external sales so that Smartbis can process cashback, points, vouchers, and communications according to the account rules.
Use document, phone, or ID to locate and keep the customer synchronized.
Send `sale_amount` by document, phone, or `customer_id` to trigger the loyalty engine.
Check coupons, vouchers, categories, and stock when the operation requires it.
Quick reference of the main endpoints.
This section works as an entry point before the complete Swagger documentation.
POST
/auth/token
Generates the Bearer token to authenticate subsequent calls.
Auth
GET
/customers
List customers or filter by document, phone, or ID, with optional pagination.
Customers
POST
/customers
Create customer with name, phone, password, and additional data.
Customers
POST
/sales
The administrator registers on the main operation. To register in a specific store, use an authorized operator's API Key for that store.
Sales
GET
/coupons
Lists available coupons/rewards for the operation.
Coupons
PATCH
/coupons/{coupon_id}/stock
Update stock of a specific reward.
Coupons
GET
/vouchers
Lists vouchers with optional pagination.
Vouchers
POST
/vouchers/{voucher_code}/validate
Validate voucher by the provided code.
Vouchers
Main objects
API resources organized by operation usage.
This page presents the API domains in product language, while the Swagger documentation maintains schema, parameter, and response details.
Register and search by document, phone, or ID, respecting the operator's visibility.
Register external purchases to generate cashback, points, or vouchers.
Listing and control of available reward stock.
Query and validation of vouchers used by the customer.
Creation and listing of categories used in operation organization.
The API Key identifies who registers the operation. The administrator records sales on the main operation; for a specific store, use an authorized operator's API Key for that store.
Need to connect your own system?
Use the interactive documentation to test endpoints, validate payloads, and align the ideal flow with the technical team.