SAMi - Smart API Marketplace Documentation

SIDGS SAMi Release Notes v2.8.3.5

 

 

SIDGS Smart API Marketplace, Innovative-Integrated

 

Version 2.8.3.5

Release Notes

Edition: 1.0

July 2023

 

© Copyright 2023 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 2023 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 v2.8.3.5

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

  • SIDGS SAMi Installation and Configuration Guide

  • SIDGS SAMi User Guides

  • SIDGS SAMi Release Notes v2.8.3.5

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 Server 2.2  

AWS, GCP, APIGEE Edge, APIGEE Hybrid, SaaS, OPDK 

SIDGS SAMi Server 2.8.3.5

AWS, GCP, APIGEE Edge, APIGEE Hybrid, SaaS, OPDK, X 

Features

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

Publisher Hub

  • Add and Update Provider Groups

  • Onboarding SKUs

  • Inviting Group Owners

  • Inviting API Providers

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

Upgrade Paths

  • SAMi v1.0 >> SAMi Mint release

  • Scratch install SAMi v2.8.3.5

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 v2.8.3.5 

  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

Fixed problems

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

ID

Description

SM-2

Monetization

SM-312

Implementation of Automatic Recurring Payment

SM-398

Add a "Cancel Subscription" button on a Rate Plan Cards in "Subscribed Rate Plan" Page

Known problems

The following problems are found in this release.

ID

Description

SM-476

Update the Rate Plan and Subscription End Date for the Developer Accepted API

Known limitations

The following limitations are found in this release.

ID

Description

1.

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.

2.

SKUs created using SAMi publisher hub are bound to a single-use proxy & product in 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