Access the API Catalog

1. From Vertafore Developer Portal top navigation menu, select the API Catalog tab.
   
   Click the image to change its size.
   
   
   
2. Click one of the boxes to select the Vertafore API that you intend to use.

 

Once you have opened one of the API catalogs, the API Reference and Documentation page displays. Click the image to change its size.

From the API Catalog page, double-click one of the API catalogs.

 

• Quick Navigation Menu
  
  
  
  The Quick Navigation module at the top of the user interface provides the following capabilities:
  • Version selection
    
    The Version selection drop-down menu allows you to view services for all versions of the APIs. The drop-down defaults to the most recent version.
  • Search
    
    The search menu provides you the ability to quickly look up services that may contain a specific word. For example, If you were to look up the word "Customer", all services that related to the word "Customer" would display.
  • Method
    
    The Method drop down allows you to filter your search results by specific operations or all operations, either GET, POST, DELETE or PUT individually, or ALL Operations together. Only the services with these Operations will display in the API results section.
    
    
    
    
• API Results Section
  
  the API Results Section (the largest section of the User Interface) provides the reference information necessary to build against the services displayed. Each service provides options to do the following:
  
  
  
  
  • Show/Hide
    
    When selected, the Reference Object expands to display all of the services and each operation that can be leveraged against that service. When selected again, the list collapses to the original view.
  • List Operations
    
    Select this option when you have already selected "Expand Operations" and would like to simply display the Reference Object and the services that can be leveraged again.
  • Expand Operations
    
    Selecting "Expand Operations" provides you a detailed view of the service's reference information.
    
    

Click the image to change its size.