API NSW

OneBlink has an integration with the NSW Government's open API. The NSW Gov API Catalogue includes several APIs that can be used for different services.

The API NSW integration currently supports the Liquor Licence API. This allows form users to search by Liquor Licence Number or Licence Name and return available licence details directly in the form.

Prerequisites

Before setting up the integration in OneBlink, you will need to create an API NSW account and configure an app.

Step 1: Register for an API NSW account using the API NSW registration page.

Step 2: Once your account has been created, create a new app in API NSW.

Step 3: Add the app name and description.

Step 4: Select the Liquor Licence API Product.

Setting up the API NSW integration

Once your API NSW app has been created, you can configure the integration in OneBlink.

Step 1: Open the Integrations menu, find the API NSW integration card and click Setup Integration.

Step 5: Enter the API Key and API Secret from your API NSW app and click Save.

Adding the Liquor Licence Lookup to a form

After the integration has been configured, you can add the Liquor Licence Lookup element to a form.

Step 1: Navigate to the form you would like to update.

Step 2: Open the form in the builder.

Step 3: Add the Liquor License element from the elements list.

Form users will now be able to type in a Liquor Licence Number or Licence Name. The element will return a list of matching results. Once the correct licence is selected, the form will display the available details related to that Liquor Licence.

Getting Help

If you need any assistance with API NSW integration, please reach out through the Report Issue menu or email support@oneblink.io.