Ocapi Licensing

Overview

OCAPI endpoints are available for custom integrations as part of our licensed features. Each feature is based around a specific business area, such as subscription management, and includes access to a subset of OCAPI endpoints. Being licensed for multiple features will give you access to more OCAPI endpoints.

Not all areas of OCAPI are currently licensed. Licensed features are listed below, and the OCAPI reference documentation indicates if a particular endpoint is licensed.

Available features

• Subscriptions
• Loyalty member photo
• Loyalty friends

Calling OCAPI endpoints without a license

All requests made to licensed OCAPI endpoints will undergo a licensing check.

If you attempt to use OCAPI endpoints that you aren't licensed for, Connect will will reject the request. In this scenario, Connect returns a response stating why you don't have access to the given endpoint. You can also refer to the Connect logs for additional information on failed requests if a licensing check is unsuccessful.

Obtaining a license

Contact Vista if you want to obtain a license for OCAPI. We'll assist you with environment configuration.

Troubleshooting

See the Licensing Troubleshooting page for details.