Product Guide | Cardium

About One APIMarketplace

Developer portal as a service

One APIMarketplace is a comprehensive platform designed to support API developers in building, testing, and deploying their applications. Our aim is to provide developers with the tools and resources they need to create innovative and powerful applications that can integrate seamlessly with your API.

One APIMarketplace offers a variety of features and resources to help developers get started quickly and easily. These include:

Multi Gateway Connectivity : One APIMarketplace supports multi API gateway connectivity, allowing developers to seamlessly integrate with multiple API gateways and manage their APIs from a single centralized platform.
API Documentation: Our documentation provides a clear and comprehensive overview of our API, including endpoints, parameters, response codes, and examples of how to use it.
Code Samples: We offer code samples in various programming languages to help developers accelerate their development process.
Support and Community: We provide support to the developers through our developer community features like articles , webinar and user cases , where developers can learn about your API(s) , understand various use cases such as how to use your API(s) and so on.
Analytics and Monitoring: One APIMarketplace also provides developers with analytics and monitoring tools, enabling them to track their API usage and performance in real-time.

We are committed to providing the best possible developer experience and supporting your developer community throughout their API development and integration journey.

Getting Started

Setting up your portal

Here you'll find everything you need to know to get started with APIM gateway connectivity and basic site configurations. Our aim is to make the process as simple and straightforward as possible, so you can start building and deploying your portal quickly.

To get started, you'll need to have an API gateway that is compatible with One APIMarketplace. One APIMarketplace supports a wide range of API gateways, including AWS, Apigee, Kong, Mulesoft & Azure. Once you've connected your API gateway to One APIMarketplace, you'll be able to sync your APIs with just a few clicks.

Before you start with API documentation , it's important to configure your site settings. One APIMarketplace provides a range of customizable options, including site branding, menus, email templates etc. . We recommend that you take some time to review and configure these settings to ensure that your site is set up and meets your specific needs.

We're excited to see what you'll build. Let's get started!

APIM Connectivity

Set up an API gateway and configure

Login to the site as an API Gateway Administrator or Product Manager.
Navigate to Manage > Sync from the left sidebar menu.
Select the API gateway you want to sync from the list, which displays the number of previously synced APIs and API products for each gateway.
Select the API gateway name and credentials from the list or menu tab, such as AWS Credentials. Once selected, input the connection details in the available fields.
To add more details, select the Add one more button.Click the Remove one button to remove the last added set of details.
Click the Submit button to save the credentials.

Menus

Log in to the site as the Portal Administrator.
From the left sidebar menu, select Manage > Menus. The page will have a list of every menu.
To access the menu detail page and see a list of all menu links, click the Edit menu button.
To change a menu link's label, click Edit, update the new label in the title field on the menu link detail page, and click Save.

Taxonomy

Log in to the site as the Portal Administrator.
Navigate to Manage > Taxonomy from the left sidebar menu. All vocabulary will be listed on the page.
Select the Add vocabulary button to add a new vocabulary.
Edit Vocabulary
1. To edit any vocabulary, select the Edit option from the drop-down menu.
2. Once the necessary changes are done, click Save.
List Terms
1. To view all the taxonomy terms for a vocabulary, simply select List Terms from the drop-down menu, and they will be loaded onto the page.
2. Click the Add Term button to add a new taxonomy term.
3. Click the Edit button to update the taxonomy term.
4. Click the Delete button to delete the taxonomy term.

SMTP

Log in to the site as the Portal Administrator.
Navigate to Manage > SMTP from the left sidebar menu.
Configure the fields under SMTP server settings and SMTP Authentication.
Under the Email options, set the default sender's email and name.
Click the Save button to save the SMTP configuration.

Email Templates

Login to the site as the Portal Administrator.
Navigate to Manage > Email Templates from the left sidebar menu.
Scroll down to the Emails section. Click on the Email Template you want to change. For instance, welcome.
You will find the detailed email template on the right side. Update the subject and body fields.
Click on the other template you want to change.
Once the desired templates are changed, click the Save Configuration button to save the changes.

People

Add users and assign roles
1. Login as a Administrator, Portal Administrator and navigate to dashboard.
2. Click on Manage > People.
3. Click on Add User button.
4. Enter all the fields and roles.
5. Click Signup.
Deleting an user
1. Log in as a Portal Administrator, and navigate to the dashboard.
2. View the list of users at Manage > People.
3. You can edit which user account needs to be deleted.
4. Click on Cancel Account to delete the user.
Describe roles
1. Portal Consumer
  1. To create an app, go to Manage > Apps > Create App.
  2. The app list can be seen under Manage > Apps.
2. API Gateway Administrator
  1. To create the app, click Manage > Apps.
  2. To create the content, go to Manage > Content.
  3. To sync the APIs and products, select Manage > Sync.
  4. Go to Manage > Sync and click any of the gateways to provide the login information.
  5. Go to the Credentials tab after selecting any gateway. Complete the form and submit it.
  6. Before syncing the API, you need to sync the API products first.
  7. Go to the product page for Sync API.
  8. You will find two options Sync all selected products and Sync all products.
  9. Go to the Sync APIs tab and sync the desired APIs.
  10. Go to Manage > API Products. Here the API gateway administrator can see the list of API products, and we can edit this product as well.
3. Product Manager
  1. To create an app, go to Manage > Apps.
  2. To create the content, click Manage > Content.
  3. To sync the APIs and products, go to Manage > Sync.
  4. Go to Manage > API Products. You can see the list of API products and edit the product as well.
4. Portal Administrator
  1. Portal administrators will get dashboard access.
  2. For the dashboard page, click User Profile Block.
  3. You can create apps by going to Manage > Apps > Create App.
  4. To see a list of apps, go to Manage > Apps > My Apps.
  5. Also, users have the provision to edit and delete the app, go to Manage > Apps > My Apps.
  6. Every app has an edit and delete icon.
  7. You can create all content under Manage > Content.
  8. Click on the Add content button.
  9. You can edit or delete the contents.
  10. You can add media by going to Manage > Files > Media.
  11. Once you select the media type and fill in the required fields, click the Add media button and save.
  12. That media will come under Manage > Files.
  13. You will get permission to edit the menus under Manage > Menus.
  14. Click the Edit Menu button, and then click Add Link to add the new menu link.
  15. You can add the new user under Manage > People.
  16. Click the Add User button, fill in the required fields, and save.
  17. User lists will come under Manage > People.
  18. Go to Manage > Taxonomy to add the taxonomy vocabulary and items
  19. Click on Add vocabulary and give a name, then save.
  20. Manage > Taxonomy will appear here, then add the terms.
  21. Click on the List Term button, then click the Add Term button.
  22. Click on Themes > Dashboard to access dashboard themes.
  23. You can set the default colors for the site's text, buttons, links, tables, pagination, and tabs here. This will apply to all pages. In the Logo Image box, you can also add a logo and a favicon.
  24. Go to Themes > Portal if you have permission for the Portal theme.
5. Administrator
  1. Administrator will get the overall site access.

Files and Media

Login to the site as an API Gateway Administrator.
Navigate to Manage > Files from the left navigation. Click on the Media tab. Click on Add Media.
Select the type of media you want to upload.
Fill in the required fields and click Save.
That media will be listed under Manage > Files.

APIs

Manage your APIs

One of the key features of our API gateway connectivity service is the ability to sync your APIs from your gateway into One APIMarketplace. This makes it easy to manage and deploy your APIs, and ensures that your developers have access to the latest and most up-to-date versions of your APIs.

Once your gateway is connected, One APIMarketplace will automatically discover your APIs and import them into our system. You can then manage and deploy your APIs from One APIMarketplace, without having to manually create and update them.

In addition to API syncing, One APIMarketplace also supports API discovery. This means that developers can easily find and access your APIs, even if they are not familiar with your specific gateway. One APIMarketplace provides a comprehensive API catalog that developers can search and browse, making it easy for them to find the APIs they need to build their applications.

To ensure that your APIs are discoverable, we recommend that you provide clear and descriptive documentation that outlines the purpose, functionality, and usage of your APIs. One APIMarketplace provides tools and resources to help you create and manage your documentation, including markdown support and versioning.

By syncing your APIs and supporting API discovery, One APIMarketplace makes it easy for developers to build and deploy powerful and innovative applications that integrate seamlessly with your APIs. So why not give it a try and see how our API gateway connectivity and discovery can help you streamline your API management process and boost your developer productivity!

Sync APIs

Login to the site as an API Gateway Administrator / Product Manager.
Navigate to Manage > Sync from the left sidebar menu.
Select the API gateway you want to sync from the list, which displays the number of previously synced APIs and API products for each gateway.
To sync APIs, click Sync [API gateway name] APIs, such as Sync AWS APIs.
A list of APIs will then be displayed, along with details such as ID, name, and source.To sync a specific set of APIs, select them and click Sync selected API(s). To sync all APIs, click Sync all APIs. A success message will appear once the syncing process is complete.

Sync API Products

Login to the site as an API Gateway Administrator / Product Manager.
Navigate to Manage > Sync from the left sidebar menu.
Select the relevant API gateway to be synced from the list, which shows the number of previously synced APIs and API products for each gateway.
Choose Sync [API gateway name] API Products, such as Sync AWS API Products. It will display a list of API products, including information such as ID, API ID(s), name, and quota.
To sync specific API products, select them and click Sync selected product(s).
To sync all API products, click Sync All Products. A success message will appear once the API products have been successfully synced.

Manual Creation

Login to the site as a Portal Administrator or Product Manager.
Navigate to Manage > Content > Add Content > APIs.
Add the following fields:
1. Title
2. API Images: The allowed image formats are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.
3. Markets and Regions
4. Domain: Unlimited terms
5. Tags : Unlimited terms
6. Solutions: Unlimited terms
7. Overview: The allowed components are:
  1. Two column Layout
  2. Video
  3. Static Content
8. Documentation: Select documentation content.
  1. Title
  2. Documentation Content: The allowed components are:
    1. FAQ
    2. Static Content
    3. Two Column Layout
    4. Video
9. Endpoint: Select any one of the components.
  1. Async API Documentation To upload Async: Click Add Media and upload Aync file. The allowed types are txt, yml and json and the maximum number of values allowed is 1.
  2. REST Documentation To upload Dapper/Swagger: Click Add Media and upload Dapper file.The allowed types are txt, yml and json and the maximum number of values allowed is 1.
  3. GraphQL Documentation To upload the GraphQL: Click Add Media and upload GraphQL file.The allowed types are txt, yml and json and the maximum number of values allowed is 1
Save the content.

API Catalog Search Features

Navigate to API(s) > API Discovery from the main menu.
APIs can be filtered based on country, tags, domain, and solution. The search bar can be used to filter the APIs by name.
Filter keywords are displayed at the top of the list. To remove the filter criteria, click the X button or uncheck/remove them from the left filter section dropdown menu.

Consuming APIs

API Subscription

With One APIMarketplace , Developers can easily create and manage applications that access and integrate with your APIs. One APIMarketplace provides a range of tools and resources to help you build and deploy powerful and innovative applications that meet the needs of your users.

To get started, developers need to create an account and subscribe to the APIs they wish to access. Once developers are subscribed to an API, they can create an application by following the steps explained below.

Once developers have created their application, they will be provided with an API key or access token that they can use to authenticate your API requests. They can then use the API key or access token in their application code to make API calls to your APIM Gateway and access the data and functionality provided by your APIs.

Subscribe to an API

Login to the site as a Portal Consumer, API Gateway Administrator, Product Manager, or Portal Administrator.
Navigate to API(s) > API Discovery from the main menu.
Click Documentation on API to subscribe.
On the API Doc page, click Subscription Options tab.
Add to List :
1. Click Subscribe Now to create an app with Subscribe API.
2. To add API to subscription list, click Add to Subscription List. Repeat for other required APIs.
3. View API list by clicking Subscriptions List, then click Subscribe Now to create an app with subscribed APIs.
Remove from List :
1. Click Subscriptions List to view the list of subscribed APIs.
2. To remove the API from the subscription list, click the cross icon beside the API name. Repeat for other required APIs.
3. Click Subscribe Now to create an app with subscribed APIs once the list is complete.

Create App

Navigate to Apps > Create App from the left sidebar menu.
On the Create App page, fill in the relevant data in the fields (App name, business email, description, etc.).
The Subscribed API bundles will be pre selected.
Click the Select API Bundles button, and select the APIs from the list, if you have not added any API to Subscription list.
Check the I agree to the API terms and conditions checkbox and click Save.

Edit App

Navigate to Apps > My Apps from the left sidebar menu.
A list of all the apps created by you will be displayed.
Click the pencil icon to edit an app. Make the necessary changes and click Save.
Portal Administrators and Product Mangers can edit any app from Manage > Content.

Delete App

Navigate to Apps > My Apps from the left sidebar menu.
A list of all the apps created by you will be displayed.
To delete an app, click the bin icon.
To permanently delete the app, click Delete.
To keep the app, click Cancel.
Portal Administrators and Product Mangers can delete any app from Manage > Content.

View My Apps

Navigate to Apps > My Apps from the left sidebar menu.
A list of all the apps created by you will be displayed.

Test your APIs

Try out APIs

API try-out feature is a valuable functionality for API developers that allows them to interactively test their APIs and experiment with different input parameters and configurations, without needing to write any code or deploy their API to a live environment.

With One APIMarketplace, the Try-it-out feature has been enabled directly on the documentation tools so that while developers learn about various endpoints, they can also perform a try-it-out to see the actual responses.

Test subscribed APIs

After subscribing to the API, on the app page you can see details like Consumer key, Consumer secret.
Copy Consumer Key and click API name to navigate to its doc page.
Click the Endpoints tab.
Click on Authentication and select API Key.
Add consumer key in Value text area, click Authorize button.
Click on the Close button to come out of the window.
Click on the Play button to test the API.

Manage Articles

About Articles

The articles feature on One APIMarketplace is a section that contains educational and informative articles aimed at helping developers better understand the APIs and tools provided by the platform. These articles may cover a wide range of topics, including best practices for API development, code samples, tutorials, case studies, and other relevant content.

The articles feature is typically intended to provide developers with the resources they need to quickly and easily learn about the APIs and tools offered by the platform. By providing high-quality, informative articles that are well-written and easy to understand, the developer portal can help developers get up to speed on the platform's APIs and tools more quickly, and troubleshoot issues more effectively.

Create Articles

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content > Add Content > Articles.
Add the below fields.
1. Title
2. Short Description
3. Tile Image - The allowed file extensions are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.
4. Article Image - The allowed file extensions are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.
5. Description
Save the content.

Edit Articles

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content.
Filter content by title or article content type.
Click on the Edit button.
Make the changes and Save the content.

Delete Articles

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content.
Filter the content by title or Articles content type.
Click on the Dropdown arrow and click the Delete button.
To delete the app permanently, click Delete. To keep content, click Cancel.
Two more options available: Delete content from View and Edit features under the content page.

Manage API Use Cases

About API Use Cases

The API use cases feature on a One APIMarketplace is a section that showcases various ways in which the platform's APIs can be used to solve real-world problems or enhance existing applications. These use cases typically include detailed explanations of the problem being solved, the APIs and tools used to solve the problem, and the benefits gained from using the platform's APIs.

The API use cases feature is intended to demonstrate the practical applications of the platform's APIs and provide developers with inspiration and ideas for how they can use the APIs to solve similar problems or enhance their own applications. By showcasing the potential of the platform's APIs, the developer portal can help developers understand the value of the platform and encourage them to use the APIs in their own projects.

Create Use Cases

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content > Add Content > Use Cases.
Add the below fields.
1. Title
2. Tile Image - The allowed file extensions are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.
3. Short Description
4. Description
Save the content.

Edit Use Cases

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content.
Filter content by title or Use cases content type.
Click on the Edit button.
Make the changes and Save the content.

Delete Use Cases

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content.
Filter the content by title or Use cases content type.
Click on the Dropdown arrow and click the Delete button.
To delete the app permanently, click Delete. To keep content, click Cancel.
Two more options available: Delete content from View and Edit features under the content page.

Manage Webinars

About Webinars

Webinars are a feature on One APIMarketplace that allows developers to view online recorded seminars or presentations. These webinars provide developers with a valuable opportunity to learn about new features, tools, and best practices related to the platform or service.

Webinars can be used to introduce new products or services, provide updates on existing features, and give developers an opportunity to ask questions and provide feedback.

Webinars are a valuable resource for developers looking to stay up-to-date on the latest developments in their field, and for platform providers looking to engage with their developer community and provide support and guidance.

Create Webinars

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content > Add Content > Webinars.
Add the below fields.
1. Title
2. Short Description
3. Image - The allowed file extensions are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.
4. Video Link: Remote Video, the allowed number of values is 1.
  1. Click "Add media" and provide Youtube/Vimeo video url and click on "Add" .
  2. Click on "Save" and click on "Insert Selected".
5. Body
6. Components
Save the content.

Edit Webinars

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content.
Filter content by title or Webinars content type.
Click on the Edit button.
Make the changes and Save the content.

Delete Webinars

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content.
Filter the content by title or Webinars content type.
Click on the Dropdown arrow and click the Delete button.
To delete the app permanently, click Delete. To keep content, click Cancel.
Two more options available: Delete content from View and Edit features under the content page.

Manage Static Pages

About Static pages

Static pages feature on One APIMarketplace can be used to provide information to developers that is not expected to change frequently, such as documentation, tutorials, FAQs, and legal information.

Developers who are new to an API or platform often rely heavily on documentation to understand how to use it. By providing static pages on a developer portal, API providers can offer developers a reliable and consistent source of information. This can help developers learn how to use the API more quickly, and reduce the likelihood of confusion or frustration.

Static pages can also be useful for providing legal information, such as terms of service, privacy policies, and licensing agreements. By hosting this information on the developer portal, API providers can ensure that developers are aware of their legal obligations and have easy access to relevant documentation.

Create Static Page

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content > Add Content > Basic Page.
Add the below fields.
1. Title
2. Body
3. Components
Save the content.

Edit Static Page

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content.
Filter content by title or Basic Page content type.
Click on the Edit button.
Make the changes and Save the content.

Delete Static Page

Login to the site as a Portal Administrator / Product Manager.
Navigate to Manage > Content.
Filter the content by title or Basic Page content type.
Click on the Dropdown arrow and click the Delete button.
To delete the app permanently, click Delete. To keep content, click Cancel.
Two more options available: Delete content from View and Edit features under the content page.

Manage Static Page Components

About Static Page Components

Creating a web page can be an exciting and challenging task. There are many elements to consider when designing a webpage, such as the layout, the color scheme, and the content. One essential aspect of creating a webpage is choosing the right components to include. A webpage can be made more effective by including components such as a banner, FAQ, slider, How It Works section, Static content, and featured content. Each of these components serves a unique purpose and can help to engage visitors, build trust, and drive conversions. When used together, these elements can create a cohesive and compelling webpage that effectively communicates the value of a product or a service.

Add Components

Select component from dropdown.
Enter the required data, add more components as needed.
Click Save after adding required components.

Duplicate Component

Click on the three-dot icon and select Duplicate.

Remove Component

Click on the three-dot icon and select Remove.

Banner

Title
Image: The allowed file extensions are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.
Text Position
Description
CTA: Both internal and external links - Maximum number of values allowed is 1.

Card

Title
Icon: The allowed file extensions are png, gif, jpg, jpeg, and svg, and the maximum number of values allowed is 1.
Description

Documentation

Title
Content
1. FAQ
2. Static Content
3. Two Column Layout
4. Video

FAQ

FAQ Title
FAQ Content
1. Question
2. Answer

Featured Articles

Title
CTA
Background Image: The allowed file extensions are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.

Featured Contents

Title
Icon: The allowed file extensions are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.
Description
CTA

Features Slider

Title
The number of sliders on each page
Description
Background Image - The allowed file extensions are png, gif, jpg, jpeg, and svg, and the maximum number of values allowed is 1.

How it Works

Title
Background Image - The allowed file extensions are png, gif, jpg, jpeg, and svg, and the maximum number of values allowed is 1.

Static Content

Content

Two column layout

Title
Image Position (default): Right
Image: The allowed file extensions are png, gif, jpg, and jpeg, and the maximum number of values allowed is 1.
Description
CTA: Both internal and external links; the maximum number of value allowed: 1.