Skip to main content

Catalog

Welcome to our API Catalog! Our Catalog is the central location where you can browse and search for APIs, Templates of Software, and components generated from the templates. This guide aims to help you navigate the catalog easily and efficiently. Here are some of the topics covered in this guide:

  1. Navigating the Catalog: to access the Catalog, go to the "Catalog" tab in the navigation bar. You can use filters to find APIs, Templates, or components based on their name or category. Once you select an item, you will see a brief description of it.
  2. Viewing APIs: When you select an API from the Catalog, you will see a detailed overview of all its endpoints, which includes the request and response parameters, and the related database structure. Our platform uses OpenAPI specification files to ensure the latest API documentation is always available.
  3. Viewing Templates: if you select a template from the Catalog, you can view all the components that are generated from that template. Each component has its own overview page where you can access its documentation.
  4. Viewing Components: when you select a component from the Catalog, you will see an overview of it, including its source code and any plugins associated with it. With our platform, you can easily customize these plugins to fit your specific business needs.
  5. Accessing Documentation: one of the unique features of our API Catalog is that you can access documentation directly from the platform. When you select an API, Template, or Component, you can click on the "Documentation" button to see all relevant documentation for that item. This means that you don't have to switch between multiple tabs or tools to get the information you need.

In conclusion, our API Catalog is a powerful tool that allows you to browse and search for APIs, Templates of Software, and components easily. With our documentation and filtering features, you can quickly find and access the information you need.

Here are some tips on how to make the most of our API Catalog:

  • Use filters to quickly find what you're looking for.
  • When browsing APIs, pay close attention to the endpoints and request/response parameters.
  • Take advantage of the OpenAPI specification files to ensure you have the latest documentation.
  • When browsing templates, explore the components that are generated from them.
  • When viewing components, take note of any associated plugins and consider customizing them to fit your specific needs.
  • Use the "Documentation" button to access all relevant documentation for a selected item.

To help you get started, we've also included a video that demonstrates how to navigate the catalog and view components. Please click on the video below to watch and learn!