SAMi - Smart API Marketplace Documentation
Publisher Hub
The Publisher Hub feature helps the Product Owner to perform specific functions related to:
Scenario 1 – To Manage Publisher Hub from the main menu
The Product Owner will be allowed to manage the Publisher Hub from main menu.
Step 1: Login as a Product Owner.
Step 2: Enter the SAMi Portal URL in the browser, and press Enter.
Step 3: Enter the Email and the Password in the respective fields and click Login.
You will land on to the Product Owner Dashboard.
Step 4: The Product Owner will navigate from Dashboard to Publisher Hub in the main menu.
Step 5: Product Owner will land on to the Publisher Hub page.
Step 6: The Product Owner will be able to search the existing provider groups using the search field. Upon search all the relevant provider groups are listed.
Add Provider Group
To add a provider group, do the following:
Step 1: Search a provider group using the search field. The Add Provider Group button appears.
Step 2: Click Add Provider Group.
The Onboard API Provider Group page appears.
Step 3: In the Onboard API Provider Group, select and fill in the required information:
Name – enter the Name in the textbox.
Group Owner – enter the Group Owner Email address in the textbox.
Gateway – Select the Gateway from the list of available options.
Environment – Select the Environment from the available list options. If you wish to add a new Environment, click on the + icon and enter the details to add.
Alias/Deployment target - enter the Alias or Deployment target in the textbox.
Step 4: Click Submit.
A success message appears, the API Provider Group is successfully onboarded.
Edit Provider Group
To update Provider Group, the PO needs to do the following:
Step 1: Product Owner will be able to Update the API Provider Groups by clicking on Edit icon.
The Provider Group Update page appears.
Step 2: Make necessary changes to the selected Provider Group.
Step 3: Click Update, to update the provider group.
A success message appears. The Provider group is updated successfully.
Onboard a SKUs/Service
The Product Owner will be able to onboard SKUs/Services after searching a product or service group using the search operation.
Step 1: Search a group by entering the keywords/service name in the search field.
Step 2: The Product Owner will be able to search a group. Clicks on Group Name.
The View API provider group page appears.
Step 3: In the View API Provider Group, click on View SKUs/Services button.
Step 4: The PO clicks on Onboard SKU/Service button.
Step 5: Product Owner will be able to Onboard an SKUs or service by entering the required details:
Enters the Display Name in the textbox provided.
Selects the Alias/Deployment target from the available list of deployment types like dev, production etc.
Selects the Options like, Security, Quota, and any other optional button selections are enabled.
Step 6: Clicks on Add Resource button.
Step 7: Clicks on Resource 1:
The Resource 1 screen expands for the PO to enter the required details.
Step 8: Product Owner enters the Path in the textbox provided.
Step 9: Selects the Method from the available list of like, Get, Post, Put, Delete etc. based on the requirement.
Step 10: Enters the Destination URL in the respective field.
Step 11: Selects the Security Type from the available list like, OAUTH2, API-KEY etc.
When you choose the OAUTH2, you need to provide the API Key, API Secret, Token Endpoint. Similarly, when you select API-KEY, you need to provide information like API Key.
Step 12: Click Submit.
The SKU/Service is onboarded, and a success message appears.
Inviting a Group Owner
To invite a Group Owner, you need to navigate to Publisher Hub from main menu and update the existing group owner and add a new group owner.
Step 1: Click on Dashboard and the Publisher Hub option on main menu.
The Publisher Hub page appears with the list of Group Owners.
Step 2: Click on Edit icon, by selecting a Group Owner from the list.
The Provider Group page opens.
Step 3: Click on the + icon besides the Group Owner to expand.
The Group Owner field appears for you to invite a new Group Owner.
A Group Owner is allowed to invite an API Provider, but on the contrary the API provider cannot invite a Group Owner.
Step 4: Enter the Email of the Group Owner to invite.
Step 5: Click on Update button.
A success message appears stating, “Provider Group has been updated successfully…”
Once you’ve invited Group Owner you will be diverted to Publisher Hub and there the new Group Owner is displayed.
The Group Owner can Invite other Group Owners and API Provider. He cannot create a New Group.
Inviting API Provider
To invite an API Provider, you need to navigate to Publisher Hub from main menu and update the existing API Provider and add a new API Provider.
Step 1: Click on Dashboard and the Publisher Hub option on main menu.
The Publisher Hub page appears with the list of Group Owners.
Step 2: Click on Edit icon, by selecting a Group Owner from the list.
The Provider Group page opens.
Step 3: Click on the + icon besides the API Publisher to expand.
The API Provider Group page opens.
Step 4: Enter the Email of the API Publisher to invite.
Step 5: Click on Update button.
A success message appears stating, “Provider Group has been updated successfully…”
The View API Provider Group page appears.
Once you’ve invited API Provider you will be diverted to Publisher Hub and there the new API Provider is displayed.
© 2024 SID Global Solutions | https://www.mysami.io | https://www.sidgs.com | +1 484-218-0021