How to generate an API

How to generate an API

  • This section will explain the method to create an API key for development purposes.
  • The API has different settings for different purposes.
  • It Also has security built-in 

Step1. Create an API

  • Navigate to Developers-API Keys

  • Click on Create

  • Provide Details for your API key.

- Provide a Name for your key

- Components

Call Centre = Select this component to be used by an external Call Centre, they will need this key to integrate from their call centre CRM/Dialing system.

Widget = Select this feature to use in SwitchTransact widgets, primarily used for lead and payment capture pages.

General = Select this option to use the API for any other related development.

CDV = Select this option to be used to check if a bank account number is valid.

- Actions (These are used for security purposes)

You can select the following Actions for your API (Read, Write or Read/Write)

- IP Ranges

Add your Public IP range here to be whitelisted. Your API can only be used from the Public IP address location (office, home etc..)

- Status

- Agent

Set an Agent to be used for this API, leave blank if no agent will be used.

  • Click on Save
  • After you saved the API, you can view the Key that was generated.

  • Click on the Actions bar to copy the API Key.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.