Skip to main content

API Services

API Services​

Slide 13

Central REST APIs​

  • Basket Rest API
  • Orders API
  • Product Rest API
  • Human Resource Rest API
  • Customer and Loyalty Account Balance Rest API
  • Promotions Rest API
  • Export Rest API
  • Inbound and Outbound Integration
  • Inventory API
  • CRM API
  • Vouchers API
  • Gift Card API
  • Administration API
  • RFID Security Configuration and API

REST API Authentication​

Anonymous

  • Some APIs do not require authentication

Authenticated

  • Token - Identity Server; Tokens: id_token (used to validate the caller of the service), site_token (used to validate the company)
  • Filter - In front of the APIs; Validates tokens before the API is called
  • Basic - Enactor User validation

REST APIs Documentation​

The Enactor REST API documentation is available via Swagger at:

https://server:39833/WebRestApi

The documentation provides a full list of available endpoints, request and response models, and the ability to test API calls directly.

Central SOAP APIs​

  • Customer and Loyalty Account Balance Rest API
  • Orders API
  • Inventory API
  • CRM API
  • Vouchers API

POS Journey APIs​

  • CRM API
  • Customer Loyalty API
  • Customer Order API
  • Inventory API
  • Vouchers API

Unified Commerce APIs​

  • Unified Commerce API Introduction
  • Extension Points
  • Prompts
  • Functions

Further Reading​

For additional information and further reading on API Services, please see the following guides:

Central REST APIs​

DocumentDescription
REST API IntroductionREST API introduction and authentication
Basket REST APIBasket REST API
Orders REST APIOrders REST API
Product REST APIProduct REST API
CRM REST APICRM REST API
Customer Loyalty and Account Balance REST APICustomer loyalty and account balance REST API
Promotions REST APIPromotions REST API
Export REST APIExport REST API
Inbound and Outbound REST APIInbound and outbound integration REST API
Inventory REST APIInventory REST API
Vouchers REST APIVouchers REST API
Gift Card REST APIGift card REST API
Administration REST APIAdministration REST API
Human Resource REST APIHuman resource REST API

Central SOAP APIs​

DocumentDescription
CRM SOAP APICRM SOAP API
Customer Loyalty and Account Balance SOAP APICustomer loyalty and account balance SOAP API
Orders SOAP APIOrders SOAP API
Inventory SOAP APIInventory SOAP API
Vouchers SOAP APIVouchers SOAP API

POS Journey APIs​

DocumentDescription
POS CRM APIPOS CRM API
POS Customer Loyalty APIPOS customer loyalty API
POS Customer Order APIPOS customer order API
POS Inventory APIPOS inventory API
POS Vouchers APIPOS vouchers API

Unified Commerce APIs​

DocumentDescription
Unified Commerce API - IntroductionUnified Commerce API introduction
Unified Commerce API - Extension PointsExtension points for customising POS behaviour
Unified Commerce API - PromptsPrompts for POS transaction interaction
Unified Commerce API - FunctionsFunctions for invoking POS operations