In the upcoming Campaign version, a new powerful feature has been added: the ability to perform common tasks through REST APIs!
Let’s explain first what the RESTful approach is that we have used to create this new functionality.
Representational state transfer (REST) or RESTful Web Services is a way of providing interoperability between computer systems on the Internet. REST-compliant Web Services allow requesting systems to access and manipulate textual representations of Web resources using a uniform and predefined set of stateless operations. REST APIs give you the possibility to perform actions and queries on your offers, such as:
- Retrieve useful data from your Offer information (query Operations and Applications, optionally using specific filters to narrow down your queries)
- Retrieve all offers
- Create new offers
- Perform changes in Offer details
- Get Offer codes
- Retire Offers
- Search for Offers
- Get Offer template details from which the offer is create
- Validate Offers
All this can be performed in a simple, safe, and quick way by using REST APIs.
Simple: REST APIs are simple to use, requiring just a URL and few parameters as input.
Safe: leveraging an HTTPS connection and basic authentication, all your data is protected when sent and received.
Quick: response time of a REST API call is in seconds!
The Campaign installation will have the Swagger documentation for the precise information for using each API and JSON payload samples.
It can be found in our documentation.
Product Manager – HCL Marketing Suite