Skip to main content

Search

We are excited to announce the launch of updated product names, logos, and headers within our user interfaces as part of the CivicPlus® Solution Rebranding initiative. These changes mark the first step toward creating a cohesive and seamless user experience across all solutions in our portfolio. As part of this transition, users may notice minor design updates. While the functionality you rely on remains unchanged, we are in the process of updating screenshots and other resources on our Help Centers to reflect the new branding. We appreciate your patience and understanding as we work to complete these updates.

API Hosting

  • Updated:

This article will show you how to create a Hosted API (application program interface). Once added, Hosted APIs can be used when setting up Option Sets, Lookups, form Validation, or Personalization & Receipt Generation. 

 

Article Navigation

 

Add an API

 

Instructions

  1. Sign in to your site
  2. Navigate to Developer Tools and select API Hosting
    API hosting in left menu.
  3. Click the + button in the bottom right corner 
    add button.
  4. Fill out the API fields
    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
  5. Click Save
    save button.
  6. Your API will appear at the top of the screen 
    API example.
  7. Use the CivicPlus CLI (command-line interface) to deploy an API environment. If you require further assistance, please don't hesitate to contact Support. 
    environments deployed for API.

 

Go to Article Navigation

 

Delete an API

 

Instructions

  1. Navigate to Developer Tools and select API Hosting 
    api hosting
  2. Click Delete API Instance (trash can icon) next to the API
    delete icon.
  3. Select Delete on the popup that says Are you sure you want to delete [API name]?
    yes delete API.

 

Go to Article Navigation

Comments

Let us know what was helpful or not helpful about the article.

0 comments

Please sign in to leave a comment.