Contributors:

API Applications

Allow external applications to securely connect to your WebinOne site instance via interactions with the Open API (both Frontend and Admin endpoints) and/or configure Webhooks for outbound notifications.

Found under 'Settings' > 'API Applications', you can manage all your API keys and Webhook endpoints for any number of applications you may need to connect. Including the ability to disable, remove or refresh keys as needed.

Create/Edit API Applications

To create API Application credentials, click the 'CREATE NEW' button at the top of the page and configure the settings as per the below options:

Name

A description name to help you identify with the API Application these credentials will be used for.

Currency/Country

Based on the domain currency/country options configured for your site instance, a single API Application connects via this currency/country profile, which is applicable to some admin settings (such as setting item prices). If your application needs to access multiple currency/country settings, additional API Application connections would need to be created and configured for each currency/country required.

Enable

API Applications are enabled by default. Deselect this checkbox to temporarily stop your API Application from accepting connections, without having to delete it altogether.

Once your API Application has been created the API Keys (Client ID and Client Secret) will be generated and become available for copying.

You will also be able to refresh the Client Secret at any time to renew the key. You'll then need to update the key in any application that are still required to access this API configuration.

Webhooks

In conjunction with an API Application setup, you can configure webhook endpoints to enable automated notifications to external applications upon various WebinOne site events and triggers.

For more details on Webhooks, see the Getting Started With Webhooks article.