This article will show you how to create a Hosted API. Once added, Hosted APIs can be used when setting up Option Sets, Lookups, form Validation, or Personalization and Receipt Generation.
Add an API
Click on the Workflow navigation and select the Settings button
Navigate to Developer Tools and select API Hosting
Click the + button in the bottom right corner
Fill out the API fields
API Subdomain: Add the subdomain for the API URL
Note:
The URL must only contain lowercase letters and numbers.
Sending Email Addresses: If applicable, enter email addresses for the API
Subnets: Choose to add subnets to the API
Security Groups: Add any applicable security groups
Click Save
Your API will appear at the top of the screen
Use the CivicPlus CLI (command-line interface) to deploy an API environment. If you require further assistance, please don't hesitate to contact Support.
Delete an API
Click on the Workflow navigation and select the Settings button
Navigate to Developer Tools and select API Hosting
Click Delete API Instance (trash can icon) next to the API
Select Delete on the popup that says Are you sure you want to delete [API name]?
