SAMi - Smart API Marketplace Documentation
Manage Assets by Product Owner
The Manage Assets feature helps the Product Owner to manage the assets on the SAMi API Marketplace portal for instance to perform the CRUD operations on the products, product features, SDKs, SKUs, API Specs and Document Libraries. The assets can be categorized into the following:
Products
Product Features
SDKs
SKUs
API Specs
Document Library
There are different scenarios provided in SAMi for the product owner’s convenience to opt any one of those to manage the assets:
- 1.1 Scenario 1: Manage Products from Product Owner Dashboard (With Approval)
- 1.1.1 Add Product
- 1.1.2 Edit Product
- 1.1.3 Delete Product
- 1.1.4 Set Permissions
- 1.1.5 Clone a Product
- 1.2 Scenario 2 - Manage Products from PO Dashboard (Without Approval)
- 1.2.1 Add Product
- 1.2.2 Edit Product
- 1.2.3 Delete Product
- 1.2.4 Set Permissions
- 1.3 Scenario 3 - Manage Products from PO Dashboard - Manage Assets Button (With Approval)
- 1.3.1 Add Product
- 1.3.2 Edit a Product
- 1.3.3 Delete Product
- 1.3.4 Clone a Product
- 1.4 Scenario 1 - Manage Products from Main Menu - Manage Assets (with Approval)
- 1.4.1 Add Product
- 1.4.2 Edit Product
- 1.4.3 Delete Product
- 1.4.4 Clone a Product
- 1.1 Scenario 1: Manage Products from Product Owner Dashboard (With Approval)
- 2 Workflow 7 – Manage Assets - Manage SDKs
- 2.1 Scenario 1 – To Manage SDKs from the main menu (With Approval)
- 2.1.1 Add SDKs
- 2.1.2 Delete SDKs
- 2.1.3 Clone SDKs
- 2.2 Scenario 2 - Add SDKs from Product Owner Dashboard - Manage Assets menu (Without Approval)
- 2.2.1 Edit SDKs
- 2.2.2 Clone SDKs
- 2.3 Scenario 3 – To manage SDK’s from Product Owner Dashboard Manage button (With Approval)
- 2.3.1 Add SDK
- 2.3.2 Edit SDK
- 2.3.3 Delete SDK
- 2.3.4 Clone SDKs
- 2.4 Scenario-4 Add SDK from the Manage Assets button (Without Approval)
- 2.4.1 Edit SDK
- 2.4.2 Clone SDKs
- 2.1 Scenario 1 – To Manage SDKs from the main menu (With Approval)
- 3 Workflow 8 – Manage Assets - Manage FAQ’s
- 3.1 Scenario 1 – To Manage FAQs from the main menu (With Approval)
- 3.1.1 Add FAQs
- 3.1.2 Edit FAQs
- 3.1.3 Delete FAQs
- 3.1.4 Clone FAQs
- 3.2 Scenario 2 – To Manage FAQs from the main menu (Without Approval)
- 3.2.1 Edit FAQs
- 3.2.2 Delete FAQs
- 3.2.3 Clone FAQs
- 3.3 Scenario 3– To Manage FAQs from the Product Owner Dashboard – Manage Assets Button (With Approvals)
- 3.3.1 Add FAQs
- 3.3.2 Edit FAQs
- 3.3.3 Delete FAQs
- 3.3.4 Clone FAQs
- 3.4 Scenario 1 – To Manage API Specs from the Main Menu - Manage Assets (With Approval)
- 3.4.1 Add API Specs
- 3.4.2 Edit API Specs
- 3.4.3 Delete API Spec
- 3.4.4 Clone API Specs
- 3.5 Scenario - 2 To Manage API Specs from the Main Menu - Manage Assets (Without Approval)
- 3.5.1 Edit API Specs
- 3.5.2 Clone API Specs
- 3.6 Scenario 3 – To Manage API Specs from the Product Owner Dashboard – Manage Assets button (With Approval)
- 3.6.1 Add API Specs
- 3.6.2 Edit API Specs
- 3.6.3 Clone API Specs (With Approval)
- 3.7 Scenario 3 – To Manage API Specs from the Product Owner Dashboard – Manage Assets button (Without Approval)
- 3.7.1 Edit API Specs
- 3.7.2 Delete API Spec
- 3.7.3 Clone API Specs
- 3.1 Scenario 1 – To Manage FAQs from the main menu (With Approval)
- 4 Manage Assets - Manage Product Document Libraries
- 4.1 Scenario 1 – To Manage Document Library from the Main Menu
- 4.1.1 Download File
- 4.1.2 Move Document
- 4.1.3 Delete File
- 4.1.4 Move the Document
- 4.1.5 Edit Tag of a Document
- 4.1.6 Delete a Document from 3 dots menu option
- 4.1.7 Filter and Order a Document
- 4.1.8 Uploading Documents
- 4.1.9 Display Files and Folders in different Views
- 4.2 Scenario 2 – To Manage Document Library from the PO Dashboard – Manage button.
- 4.3 Scenario 3 – To Manage Document Library from Manage Assets – Document Library
- 4.3.1 Edit a Folder from Top menu or from 3 dot menu option
- 4.3.2 Delete a Folder from Top menu or from 3 dot menu option
- 4.3.3 Move a Folder from top menu or 3 dots menu option
- 4.3.4 Add Folder from 3 dots menu option
- 4.3.5 Download a Folder from the 3 dots menu option
- 4.3.6 Access from Desktop from the 3 dots menu option
- 4.1 Scenario 1 – To Manage Document Library from the Main Menu
- 5 Manage Assets - Manage Product Features
- 5.1 Scenario 1 – To Manage Product Features from the Main Menu (With Approvals)
- 5.1.1 Add Features
- 5.1.2 Edit Product Feature
- 5.1.3 Delete a Product Feature
- 5.1.4 Clone Features
- 5.2 Scenario - 2 To Manage Product Features from the Main Menu (Without Approval)
- 5.3 Scenario 3 – To Manage Products Features from the Product Owner Dashboard - Manage Assets button (With Approval)
- 5.3.1 Add Features
- 5.3.2 Edit a Feature
- 5.3.3 Delete a Feature
- 5.3.4 Clone Features
- 5.4 Scenario 4 – To Manage Products Features from the Product Owner Dashboard - Manage Assets button (Without Approval)
- 5.4.1 Edit Product Features
- 5.4.2 Clone Features
- 5.1 Scenario 1 – To Manage Product Features from the Main Menu (With Approvals)
- 6 Manage Assets - Manage API SKU’s
- 6.1 Scenario 1 – To Manage API SKU’s from the Main Menu (With Approval)
- 6.1.1 Add API SKU’s
- 6.1.2 Edit the API SKU’s
- 6.1.3 Delete API Skus
- 6.2 Scenario 2 – To Manage API SKU’s from the Main Menu (Without Approval)
- 6.2.1 Edit the API SKU’s
- 6.2.2 Delete an API Skus
- 6.3 Scenario 3 – To Manage API SKU’s from the Product Owner Dashboard – Manage Assets button (With Approval)
- 6.3.1 Add API SKU’s
- 6.4 Scenario 4 - Add API SKU’s from Manage Assets button (Without Approval)
- 6.4.1 Edit the API Skus
- 6.4.2 Edit the API Skus
- 6.4.3 Delete an API SKUS
- 6.1 Scenario 1 – To Manage API SKU’s from the Main Menu (With Approval)
Scenario 1: Manage Products from Product Owner Dashboard (With Approval)
In Manage Assets, the Product Owner will be able to a Create New Product from the Product Owner Dashboard.
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.
Step 4: You will land on to Product Owner Dashboard.
In the PO Dashboard page, you will be able to do the following:
Add Product
Edit Product
Delete Product.
Set Permissions.
Add Product
Step 1: In Product Owner Dashboard, click Create Product.
The Manage Assets page is displayed.
Step 3: In the Manage Assets page, enter the following:
Enter the Title of the product.
Select the Product Image (Select image or Click here to upload additional images),
If the Product Image is not selected the system will by default selects a default image for that particular product.
Enter the Description in the text area.
Check on Featured checkbox, if would like to create a featured product, otherwise uncheck it.
Select the Product Category Example: SamOne/Network/MCI-APIs/SMI_APIs
Select Related Products, if the product is related to other products in the portal.
Select the Display Date, if you wish to display the product from specific date, otherwise leave it blank as it automatically captures the current date to display.
When you check Never Expire, the product will not expire anytime in future. Note: when you uncheck it, if you need to provide Display date and Expiry date as well.
Enter keywords, as many as possible, this will be helpful to search the product later.
Select Asset Categorization, to list the product in the available list of categories.
Choose the role permissions Viewable By (External Developer/Internal Developer/Product Manager/SAMi Admin/User)
Step 4: Click Submit.
Step 5: Click Cancel, if you wish to abort the operation and close the page.
When the Submit button is clicked, a Success message appears. An email notification is sent to the Product Owner.
Now, the product is created and is listed in the Manage Assets - Products list.
The Product is created and listed in the Products page but, the SAMi Admin needs to approve the product as it will remain in Pending Status, till the time the SAMi Admin approves it.
An email notification is sent to the Administrator as well to review and approve the product.
After the SAMi Administrator approves the product, the PO will be able to view the product in Manage Assets page after login in to the SAMi Portal and the product Status will be shown as, ‘Active.’
Edit Product
To edit the product from Product Owner Dashboard, do the following:
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 Product Owner Dashboard.
Step 4: From Product Owner Dashboard, browse the product to edit it.
Step 5: Click on Edit icon in the product card.
The Product details page appears.
In Product page, add or update any of the sections like, Title, Description, Product Category, Check or uncheck Featured checkbox, if you’d like to make it a featured product or general product, Related Products, Display Date, Asset Categorization, and Viewable By.
Step 6: Click Submit.
A success message is displayed stating, the product is successfully updated.
An email notification is sent to the PO.
A success message is displayed stating, the product is successfully updated but the product will be in ‘Pending’ Status. As shown below.
When the SAMi Administrator receives an email notification, and the admin login to the SAMi portal with his credentials and approves it.
Delete Product
To delete a product from Product Owner Dashboard, do the following:
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 Product Owner Dashboard.
Step 4: From Product Owner Dashboard, browse the product to delete it.
Step 5: Click on Delete icon in the product card.
A product is in the Pending status, the PO will not be able to delete it. Unless the status is changed to Active.
A delete confirmation popup appears. Click Yes to delete and click No to cancel.
The selected product is deleted. A confirmation message appears stating, “Product Deleted Successfully.”
Set Permissions
To set permissions for a product from Product Owner Dashboard, do the following:
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 Product Owner Dashboard.
Step 4: From Product Owner Dashboard, browse the product to set its permissions.
Step 5: Click Permissions icon.
The Manage Permissions page is displayed.
Step 6: In Manage Permissions page, the product owner will be able to set product permissions based on different user roles by clicking on required checkboxes.
Also, in Manage Permissions, you can search specific user roles to grant permissions by using keywords in the search field.
Step 7: Click Save.
The selected users are granted permissions based on the selections made.
Step 8: Click Cancel to abort setting permissions and close the window.
Clone a Product
To clone an existing product, do the following:
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 Password in the respective fields and click Login.
Step 4: You will land on to Product Owner Dashboard.
Step 5: By default, the Products are listed, select the product and click on the Clone icon.
A Clone confirmation dialog box appears.
Step 6: Click Yes, to confirm.
A success message appears, the product will be in ‘Pending’ Status.
The PO will receive an email notification mentioning, the product is pending for approval.
Also, the SAMi Administrator will receive an email notification mentioning, the product-clone is for review in the workflow.
When the SAMi Admin reviews and approves the clone of the product, the product will be displayed in the product list, and it will show the status as ‘Active’.
The process of Cloning an asset is same for Products, API Specs, API SKUs, Features, SDKs, and FAQs.
Scenario 2 - Manage Products from PO Dashboard (Without Approval)
In Manage Assets, the Product Owner will be able to a Create New Product from the Product Owner Dashboard.
The PO can perform the following operations from PO Dashboard:
Add Product
Edit Product
Set Permissions
Delete Product
Add Product
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.
Step 4: You will land on to Product Owner Dashboard.
Step 5: Clicks on Create Product button.
The Manage Assets page is displayed.
Step 6: In the Manage Assets page, enter the following:
Enter the Title of the product.
Select the Product Image (Select image or Click here to upload additional images),
If the Product Image is not selected the system will by default selects a default image for that product.
Enter the Description in the text area.
Check on Featured checkbox, if would like to create a featured product, otherwise uncheck it.
Select the Product Category Example: SamOne/Network/MCI-APIs/SMI_APIs
Select Related Products if the product is related to other products in the portal.
Select the Display Date, if you wish to display the product from specific date, otherwise leave it blank as it automatically captures the current date to display.
When you check Never Expire, the product will not expire anytime in future. Note: when you uncheck it, if you need to provide Display date and Expiry date as well.
Enter keywords, as many as possible, this will be helpful to search the product later.
Select Asset Categorization, to list the product in the available list of categories.
Choose the role permissions Viewable By (External Developer/Internal Developer/Product Manager/SAMi Admin/User)
Step 7: Click Submit.
Step 8: Click Cancel, if you wish to abort the operation and close the page.
When the Submit button is clicked, a Success message appears.
The PO will be able to view the product in Manage Assets page after login in to the SAMi Portal and the product Status will be shown as, ‘Active.’
Edit Product
To edit the product from Product Owner Dashboard, do the following:
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 Product Owner Dashboard.
Step 4: From Product Owner Dashboard, browse the product to edit it.
Step 5: Click on Edit icon in the product card.
The Product details page appears.
In Product page, add or update any of the sections like, Title, Description, Product Category, Check or uncheck Featured checkbox, if you’d like to make it a featured product or general product, Related Products, Display Date, Asset Categorization, and Viewable By.
Step 6: Click Submit.
A success message is displayed stating, the product is successfully updated.
The PO will view the updated product in the product list with the status as 'Active”
Delete Product
To delete a product from Product Owner Dashboard, do the following:
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 Product Owner Dashboard.
Step 4: From Product Owner Dashboard, browse the product to delete it.
Step 5: Click on Delete icon in the product card.
A product is in the Pending status, the PO will not be able to delete it. Unless the status is changed to Active.
A delete confirmation popup appears. Click Yes to delete and click No to cancel.
The selected product is deleted. A confirmation message appears stating, “Product Deleted Successfully.”
Set Permissions
Set permissions for a product from Product Owner Dashboard, do the following:
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 Product Owner Dashboard.
Step 4: From Product Owner Dashboard, browse the product to set its permissions.
Step 5: Click Permissions icon on the selected product card.
The Manage Permissions page is displayed.
Step 6: In Manage Permissions page, the product owner will be able to set product permissions based on different user roles by clicking on required checkboxes.
Also, in Manage Permissions, you can search specific user roles to grant permissions by using keywords in the search field.
Step 7: Click Save.
The selected users are granted permissions based on the selections made.
Step 8: Click Cancel to abort setting permissions and close the window.
Scenario 3 - Manage Products from PO Dashboard - Manage Assets Button (With Approval)
The Product Owner will be able to Manage Products from the Manage Assets button from the Product Owner Dashboard.
In the Manage Assets page, you will be able to do the following:
Add Product
Edit Product
Delete Product.
Clone a Product
Add Product
The add product feature helps you to create a new product by clicking on Add Product button in Manage Assets page.
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 Product Owner Dashboard.
Step 4: Click Manage Assets button.
The Manage Assets page is displayed.
Step 5: In the Manage Assets page, enter the following:
Enter the Title of the product.
Select the Product Image (Select image or Click here to upload additional images),
If the Product Image is not selected the system will by default selects a default image for that particular product.
Enter the Description in the text area.
Check on Featured checkbox, if would like to create a featured product, otherwise uncheck it.
Select the Product Category Example: SamOne/Network/MCI-APIs/SMI_APIs
Select Related Products, if the product is related to other products in the portal.
Select the Display Date, if you wish to display the product from specific date, otherwise leave it blank as it automatically captures the current date to display.
When you check Never Expire, the product will not expire anytime in future. Note: when you uncheck it, if you need to provide Display date and Expiry date as well.
Enter keywords, as many as possible, this will be helpful to search the product later.
Select Asset Categorization, to list the product in the available list of categories.
Choose the role permissions Viewable By (External Developer/Internal Developer/Product Manager/SAMi Admin/User)
Step 6: Click Submit.
Step 7: Click Cancel, if you wish to abort the operation and close the page.
When the Submit button is clicked, a Success message appears. An email notification is sent to the Product Owner.
Now, the product is created and is listed in the Manage Assets - Products list.
The Product is created and listed in the Products page but, the SAMi Admin needs to approve the product as it will remain in Pending Status, till the time the SAMi Admin approves it.
An email notification is sent to the Administrator as well to review and approve the product.
After the SAMi Administrator approves the product, the PO will be able to view the product in Manage Assets page after login in to the SAMi Portal and the product Status will be shown as, ‘Active.’
Edit a Product
To edit a product from the Manage Assets button from the Product Owner Dashboard, do the following:
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 Product Owner Dashboard.
Step 5: Clicks on Manage Assets button on the PO Dashboard.
The Manage Assets page appears.
Step 6: From Product Owner Dashboard, browse the product to edit it.
Step 7: Click on Edit icon of the product.
The Product details page appears.
In Product page, add or update any of the sections like, Title, Description, Product Category, Check or uncheck Featured checkbox, if you’d like to make it a featured product or general product, Related Products, Display Date, Asset Categorization, and Viewable By.
Step 8: Click Submit.
A success message is displayed stating, the product is successfully updated.
An email notification is sent to the SAMi Admin to review and approve the product.
A success message is displayed stating, the product is successfully updated but the product will be in ‘Pending’ Status. As shown below.
When the SAMi Administrator receives an email notification, and the admin login to the SAMi portal with his credentials and approves it.
Delete Product
To delete a product from the Manage Assets button from the Product Owner Dashboard, do the following:
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 Product Owner Dashboard.
Step 4: From Product Owner Dashboard, browse the product to delete it.
Step 5: Clicks on Manage Assets button on the PO Dashboard.
The Manage Assets page appears.
Step 6: Click on Delete icon of the product.
A product is in the Pending status, the PO will not be able to delete it. Unless the status is changed to Active.
A delete confirmation popup appears. Click Yes to delete and click No to cancel.
The selected product is deleted. A confirmation message appears stating, “Product Deleted Successfully.”
Clone a Product
To clone an existing product, from the Manage Assets button from the Product Owner Dashboard.do the following:
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 Password in the respective fields and click Login.
You will land on to Product Owner Dashboard.
Step 4: Clicks on Manage Assets button on the PO Dashboard.
Step 5: By default, the Products are listed, select the product and click on the Clone icon.
A Clone confirmation dialog box appears.
Step 6: Click Yes, to confirm.
A success message appears, the product will be in ‘Pending’ Status.
The PO will receive an email notification mentioning, the product is pending for approval.
Also, the SAMi Administrator will receive an email notification mentioning, the product-clone is for review in the workflow.
When the SAMi Admin reviews and approves the clone of the product, the product will be displayed in the product list, and it will show the status as ‘Active’.
The process of Cloning an asset is same for Products, API Specs, API SKUs, Features, SDKs, and FAQs.
Scenario 1 - Manage Products from Main Menu - Manage Assets (with Approval)
© 2024 SID Global Solutions | https://www.mysami.io | https://www.sidgs.com | +1 484-218-0021