Portal Structure

Our documentation portal is designed to provide an intuitive and user-friendly experience. Below, you'll find information on how to navigate the portal and what you can expect to find.

Navigation Bar

The navigation bar across the top has the following items:

1. Home: This link takes you back to the original landing page.
2. API Catalog: This link takes you to the catalog where all the API documentation is mapped, allowing you to select the API documentation you wish to view.
3. Search Option: At the top right, there is a search option to help find documentation within the portal.
4. Light/Dark Mode Toggle: A button to alternate between light and dark mode of the screen.

Home Page

On the home page, there is also a navigation bar down the left that provides links to high-level resources.

• Information Dropdown: This dropdown provides essential information regarding the API and how to use the feedback tool in this portal.
• API Catalog: This link takes you to the same location as the top navigation bar link, allowing you to access the API catalog.

Individual API Product Pages

Inside each of the individual API products, the sidebar will change from the home page and will have the following structure:

1. Getting Started: This section contains information on how to begin with the API and follows the same process for all the API pages.
2. Resources: This link indicates on one page everything that is available within that product for assisting with its use. Essentially a site map for the Product Documentation drop down in the side bar.
3. Product Documentation: This dropdown provides specific help information for this product only. It may include but not limited to:
   • Process flows
   • Parameter dependency charts
   • Detailed information for specific product API dependencies
4. API Documentation: This section allows you to view the actual API documentation.

By understanding this structure, you can navigate the portal more effectively and find the information you need quickly.

We hope this guide helps you make the most of our documentation portal. If you have any feedback, please use the feedback tool available on each page.