Syvizo API Platform Overview

---

Syvizo API Platform gives all the required features to create and manage APIs.

There are different components in the platform for managing stages of an API:

1. API Design Studio: This is a simple to use and intuitive platform to design and modify your APIs. If you have existing OpenAPI/Swagger specifications in json or yaml format, you can import them to create an API project. Alternatively, you can start with a blank project and design your APIs. The API specifications can be exported to json or yaml format anytime. It supports all the components from the OpenAPI specifications.

2. API Validator: This is the UI to test APIs. The APIs can be created by you or they can be from external source. Validator projects can be created with multiple endpoints and domains. It provides features to test APIs by specifying the required parts of the APIs such as headers, parameters, request body and any security required by APIs. The projects can be saved for later testing. The saved testing projects can be reused for multiple environments. Validations can also be created in the projects and saved for running tests later. The validations are done against the set expected response outputs from APIs in specific headers and/or fields in the body.

3. API Collaborator: This is serves as API catalog and is the central place to view API documentation of your APIs and the APIs published by other users on the platform. The APIs can be searched based on API name, endpoints and publisher groups. Mock data for testing APIs before they are developed can be generated based on specifications given by the API creator. The system generates automated responses based on the mock data setup and in case the API has multiple responses set, the mock data is generated random for different responses. For ease of developers, the client code to use APIs is also generated in various programming languages such as Java, JavaScript, Python, Go and C#. It gives a testing UI to test APIs which responds with mock data that is set for those APIs.

4. API Manager: This is the user interface for API Gateway. Various kinds of policies such as security, traffic management, transformation of API request and response and extension policies are configured using the user interface. The user interface gives the complete view of the API flow and all the configured policies on the screen. The policies can be configured on any of the request components and information from extension policies. It provides UI to view and map fields from request and response and processed information from other policies.

5. Access Manager: This is the component to manage various accesses on the Syvizo API Platform. The administrator(s) can create, modify or remove users, groups, roles and access to assets such as projects from API Designer, API Validator, API Manager, Developer Portal, API products and mock data. The owners of the assets can also modify the access privileges to other users from relevant components of the platform.

6. API Products: The APIs endpoints can be grouped to create an API product. These products have their product lifecycle of publishing, usage by consumers/developers. API products can be created and managed on the platform. 

7. Developer Portal: This component serves as the interface to the developers that consume the APIs developed by your teams. APIs or API products that are published to the portal can searched and API documentation can be viewed. The developers can optionally get the sample client code to call the APIs. An easy to use, no code platform is provided to design the portal which is available to the users immediately after design. No code is required to create portal pages and/or integrate it to search available API documentations.

8. API Insights: This component provides various metrics of API usage. Information required for the analysis is logged and insights that are meaningful to business users or technical teams are generated. These analytics dashboards can be filtered for the data that is of interest. The analytics is available to get insights such as API requests received, type of responses sent from API gateway, the type of response sent from the backend API, performance metrics of the gateway, performance metrics of the backends, type of devices from which requests are received, error codes analysis, latency analysis.

The navigation between the components within the fully integrated platform can be either via dashboard (the first screen after the login) that shows all the available components or via context action menu:

Takes user to the API Flow Manager component for the current project

Takes user to the API Collaborator component for current project

Takes user to the API Design Studio component for current project

Takes user to the API Validator component for current project

Open dialog to manage access for current project

The context menu is different for API Collaborator component dashboard and API documentation within API Collaborator component to provide relevant actions.

For API Collaborator dashboard, the context action menu is:

Takes user to API Collaborator dashboard

Opens API Product management pane

Opens Developer Portal Management dashboard

Opens Insights component to show various analytics metrics for the platform

The Project documentation within API Collaborator, the context action menu is:

Takes user to API Collaborator dashboard

Opens API Design component for current project

Takes user to API Flow Manager component for the current project

Exports current project specifications to a file

Open dialog to manage the access to current project

Takes user to the API Validator component for current project 

Takes user to setup mock data for current project

Takes user to API Development Studio for current project