Beta. These pages are generated from the contracts Extole’s component library publishes, and they cover the features that declare operations today. More features follow. Tell your Extole contact which ones you need next.
purchased event, rendering the banner promotion.
Read a feature’s operations when you are integrating against that feature specifically. Read the platform APIs when you need events, persons, zones, or configuration.
How These Differ
Three differences matter when you integrate. A feature has to be installed before its operations exist. Features are installed into a program, so an operation is only available to you once the feature it belongs to is part of your campaign. If a call returns404, confirm the feature is installed before treating it as an error.
A program can hold more than one of the same feature. Two onsite promotions in one program each render their own zone and keep their own configuration, so a request has to identify which one it is addressing.
The operations reuse the platform endpoints. A feature operation is a documented, named use of an endpoint you may already be calling. Every business event in the navigation is a POST to the events endpoint under its own name, and every piece of content is a render of the zone endpoint under its own name. The operation tells you which name to use and what it carries.
Reading an Operation
Each operation lists its request and response schemas, its path parameters, the authentication it accepts, and the errors it returns — the same layout as the platform APIs. An operation either reads something, such as rendering a piece of content, or changes something, such as submitting a business event. The operation’s own description says which, because the method does not: a render that receives targeting data is aPOST and still changes nothing.
Operations are listed under the feature that publishes them, and a feature appears here as soon as its components declare their operations.