SAMi - Smart API Marketplace Documentation

SIDGS SAMi v3.0.0 - Release Notes

Owned by Manikanta Swamy G
Last updated: Apr 03, 2024 by Praneeth Nerimetla

 

 

SIDGS Smart API Marketplace, Innovative-Integrated

 

Version 3.0.0

Release Notes

Edition: 1.0

Oct 2023

 

© Copyright 2024 SID Global Solutions

 

Legal Notices

Warranty

The information contained herein is subject to change without notice. The only warranties for SIDGS products and services are outlined in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. SIDGS shall not be liable for technical or editorial errors or omissions contained herein.

License Requirement and U.S. Government Legend

Confidential computer software. Valid license from SIDGS required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Copyright Notices

© Copyright 2024 SIDGS

Trademark Notices

Java™ is a trademark of Oracle and/or its affiliates.

Microsoft®, Internet Explorer, Windows®, Windows Server 2007®, Windows XP®, and Windows 7® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Firefox® is a registered trademark of the Mozilla Foundation.

Google Chrome® is a trademark of Google Inc.

Oracle® is a registered U.S. trademark of Oracle Corporation, Redwood City, California. EnterpriseDB® is a registered trademark of EnterpriseDB.

Postgres Plus® Advanced Server is a registered U.S. trademark of EnterpriseDB. UNIX® is a registered trademark of The Open Group.

Figures

Figure 1 Components of SAMi

Preface

The Release Notes describe critical information related to the SIDGS SAMi v3.0

Please read this document before installing or using this software.

Audience

Here are some recommendations based on possible audience profiles: Solution Developers, Software Development Engineers, Product Managers, and QA Engineers.

Typographical Conventions

Font Style

Usage

Font Style

Usage

Courier Font:

  • Source code and examples of file contents.

  • Commands that you enter on the screen.

  • Pathnames

  • Keyboard key names

Italic Text:

Filenames, programs and parameters.

  • The names of other documents are referenced in this manual.

Bold Text:

  • To introduce new terms and to emphasize important words.

Associated Documents

  • SAMi Installation and Configuration Guide

  • SAMi Administration User Guide v3.0

  • SAMi Post Installation and Administration Guide v3.0

  • SAMi User Guide v3.0

  • SAMi Release Notes v3.0

Overview

Smart API Marketplace
SAMi is a marketplace with a Unified Catalog of API based Products created and managed by the Product and engineering teams

SAMi is a one-stop marketplace for app developers to discover, try, subscribe and use APIs provided by the numerous API Gateways community that focuses on enabling API based Solutions

Below is an architecture outlay for your reference

API Architecture Diagram

Software Versions

The software versions referred to in this document:

Product Version

Supported Platforms

Product Version

Supported Platforms

SIDGS SAMi Version 3.0.0  

AWS, GCP, APIGEE Hybrid, Saas, OPDK, X 

 

Platform

Versions

Platform

Versions

Kubernetes Cluster

1.23

Kubernetes Nodes

1.23

Database Postgres

PostgreSQL 12.14

S3/GCS

N/A

Liferay -CE

Liferay-7.3.7-ga8

Elasticsearch Version

7.17.3

React

14.19.3

jQuery

3.5.

Release Helm Charts

Helm Chart - Portal

Helm Chart - Integration

Helm Chart - Portal

Helm Chart - Integration

865615422972.dkr.ecr.us-east-1.amazonaws.com/sam-modules:3.0.8 - Liferay

865615422972.dkr.ecr.us-east-1.amazonaws.com/sam-web-server:3.0.8 -Integration

865615422972.dkr.ecr.us-east-1.amazonaws.com/sidgs/sam-portal-elasticsearch:v2 - Elastic search

skyline-opdk-connector-chart-3.0.0.tgz

sky-gateway-api-chart-3.0.0.tgz

SAMi Features Snapshot

SAMI Marketplace & Configuration

  • Unique APIs marketplace with API-Product catalogs, Order, Entitlement, and Fulfillment Management

  • User Dashboards for Product Owners, Developers, and Partners

  • Elastic Search for Products across multiple categories

  • Marketplace styling, Notifications and Alerts

SAMI API Product Management

  • Unified Product Catalog Management of multiple Product categories.

  • Set Recommendation of Products for user consumption.

  • Monetize API-Products with personalized Rate plans for products with a single product supporting multiple rate plans.

  • User Ratings for products.

Subscription Management

  • Centralized Subscription Management for all category API-products.

  • Active & Inactive subscription listings with individual Active durations & Subscription Approval Management.

  • Profile Management of individual developers, Product Managers, and Administrators.

  • Product Unsubscribe and App disablement options are available.

Monetization

  • Monetize assets.

  • Create Multiple rate plans for users.

  • User-specific product rate-plan capability.

  • Billing Reports with earnings per product and rate plans based.

  • PayPal integration for monetization.

  • Recurring payments for API subscriptions.

Assets Management

  • Manage all assets like SDKs, API specifications, Product Features & FAQs from a single pane.

  • Reuse Assets for Products resulting in efficient portfolio consolidation.

  • Create & manage Product SKUs with versioning & permissions for users.

  • Quick search capabilities and display customizations for individual assets' documentation

Apps & teams

  • Define Apps & create teams to collaborate on the development.

  • Invite developers/subscribers for Apps.

  • Built-in approvals workflow capability.

  • Unsubscribe users and Apps.

API Consumer Management

  • Unified catalog for all API gateways.

  • Guest user onboarding & unified catalog.

  • API Product Subscription Management.

  • System, Application Alerts, Notifications & Announcements broadcast.

  • Built-in Sandbox capabilities.

  • Real-time Theme-Ing & UX capabilities.

Support

For correspondence contact SIDGS-SAMi support, mail to: sami-connect@sidgs.com for queries, details, upgrades, renewals, or correspondence. For additional information, visit: https://www.mysami.io

The Software support area of the Software Website includes the following:

  • Downloadable documentation.

  • Troubleshooting information.

  • Patches and updates.

  • Problem reporting.

  • Training information.

  • Support program information.

New Features/Enhancements  

Following are the new features/enhancements added to the SIDGS SAMi v3.0.0 

  1. Foundation: GCP Platform Manual Deployment Process is supported

  2. API Management Platform: APIGEE Edge integration is enhanced with bug fixes.

  3. SAMi Portal/Subscriber Portal: Changes to SAMi Login pages and Captcha is enabled.

  4. Product Management/Product Owner Portal/Products: Create and Update Categories

  5. SAMi Customer Support: Online and Offline SAMi Help Documentation

  6. Manage Assets: Inline Document View, Clone Asset and Assets Approval with Review Workflow is supported.

  7. Apps & Teams: Product Owner Team and approval process for invited users.

  8. Partner Management: User Onboarding for partners is enhanced.

  9. SAMi Analytics: Publisher/PO Dashboards and Subscriber/Developer Dashboards showcasing analytical data.

SAMi Software licensing

For correspondence contact SIDGS-SAMi support, mail to: sami-connect@sidgs.com for queries, details, upgrades, renewals, or correspondence. For additional information, visit: https://www.mysami.io

SAMi Manual Configurations

  1. License File

  2. Re-indexing the Search.

  3. Email Configurations.

  4. Marketplace Configurations.

  5. Role Request Workflow.

  6. User Onboarding Workflow.

  7. Web Content Article Workflow.

  8. Document Workflow.

Fixed Problems

The following problems are fixed in this release since the last release.

ID

Description

SM-1683

Issue in My Subscription "Cannot Cancel the Subscription"

SM-1727

Billing Reports are not updating for Edge Mint & Apigee X Products

SM-1767

Issue in Apps page cannot see the created app after subscribing the monetized products.

SM-1790

Cancel Subscription Button is still Active after cancelling the subscription from My Subscription Page

SM-1831

Unable to create the Products from PubHUb - showing "500 Internal server error."

SM-1875

Issue in "Subscribing the products for Apigee-X created from Publisher hub And Apigee."

SM-1881

Issue in Manage plan when end date is given no active rate plan it was showing for both Edge and Apigee-X

SM-1867

Issue in Rate Plan Subscription Management "The Subscribed details are getting cancelled."

SM-1892

Unable to subscribe to a X Product when Rate Plan created with Start date and End Date with Start fee as Zero and Base fee as some amount.

Known Problems

The following problems are found in this release.

ID

Description

SM-1608

Issue in App Page for the invited Team to subscribe a Product. 

SM-1733

Issue in Notification template page for selecting Time option is not clickable in Firefox browser.  

SM-1108

Pagination is showing when filtering with Ratings for One Product

SM-1801

Issue in Message Board "The Expired Products are visible when we create a new thread."

SM-1808

Issue in Publisher Hub "Cannot create the SKU when "TPM" field is empty in SKU creation from page."

SM-1814

Manage option for Apps should be disabled after Cancel the Subscription

SM-1818

Broken Link for "Recommendation & Companion Products" under Product Catalog Page

SM-1819

Unable to create a Rate Plan to the Product created from PubHub when the Product length is reaching Maximum.

SM-1828

Updating Apps - Custom Attributes Add Button is not Clickable.

SM-1829

Issue In Rate Plan Subscription Management "The Rate Plan Name is different & We cannot see the Rate Plans Name also."

SM-1888

Broken link in Product Catalog Page For the link of Product 

SM-1895

Product should not be visible in Featured Product once it is Expired.

 

Note: The above issues will be fixed in next upcoming releases. Above issues are a representative list and an exhaustive list is maintained by the product team.

Known Limitations

The following limitations are found in this release.

Feature

Description

  1. Product Limitation

Once a consumer cancels a Rate Plan Subscription, it is mandatory for the consumer to purchase the plan again. Refunding the prorated amount or having access to the Rate Plan till the end of the month is currently not available.

  1. Asset Limitation

Cannot create a duplicate Asset (Catalog, API SKU, Feature, API Spec)

  1. SKU Limitation

Cannot attach more than one SKU to a Catalog for same type of Org.

  1. Rate Plan Limitation

Not more than one Active Rate Plan to a Monetized Product

  1. PubHub Limitation

Approvals are not applicable to PubHub Product creations.

  1. App Limitation

Cannot subscribe Non-Mint or Mint Product to the Existing Mint App

  1. PubHub Product Limitation

Product length should not be more than 50 Character when creating the Product from PubHub as it is adding Group name, Environment and Product name in the Apigee.

Deprecations

There are no deprecations found in this release.

 

© 2024 SID Global Solutions | https://www.mysami.io | https://www.sidgs.com | +1 484-218-0021