API Interfaces

The N-Squared Voucher Server provides two API endpoints:

1. The Management API supports create/read/update/delete (CRUD) requests on voucher management data such as voucher batches, voucher types and channels. The Management API follows general REST principles in its design and requires authentication via the configured auth method (e.g. OAuth). Read the OpenAPI Documentation here.
2. The Service API supports real-time voucher processing requests such as voucher generation, voucher redemption, and voucher query. The Service API is a HTTP(S) based API and is secured based on service channel configuration stored in the voucher server’s management database.

Some overlap between these APIs exist where the same information or function is required through both APIs. The voucher server is designed such that frontends - including BSS systems - use the management API exclusively, and the Service API is used exclusively in middleware Enterprise Service Bus (ESB) integration.