diff --git a/README.md b/README.md index 675fa59914..2996317732 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ +WSO2 logo + # WSO2 API Manager [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![stackoverflow](https://img.shields.io/badge/Get Support on Stack Overflow-wso2am-orange)](https://stackoverflow.com/tags/wso2-am/) -[![Join us on Discord](https://img.shields.io/badge/Join us on Discord-wso2--apim-blueviolet)](https://discord.com/invite/wso2) +[![Join the community on Discord](https://img.shields.io/badge/Join us on Discord-wso2--apim-blueviolet)](https://discord.com/invite/wso2) --- @@ -10,9 +12,28 @@ WSO2 API Manager is a complete platform for building, integrating, and exposing It allows API developers to design, publish, and manage the lifecycle of APIs and API product managers to create API products from one or more APIs. -To learn more about WSO2 API Manager please visit http://wso2.com/products/api-manager. +To learn more about WSO2 API Manager please visit https://wso2.com/products/api-manager. + +> If you run your workloads on Kubernetes, we recommend you check our specific solution for the Kubernetes platform https://wso2.com/api-platform-for-k8s/ +> + +# Why WSO2 API Manager? + +From simple scenarios to comprehensive protocol support, WSO2 API Manager can handle it all. Use industry standards or extend our platform to integrate with your existing business needs, applications, and architectures. Tailor it to your exact use case, whether that means customizing the user interface, mediation, security, or integrating third-party solutions. + +### Interoperability with Open Standards + +* Achieve seamless interoperability between diverse systems without vendor lock-in, utilizing modern approaches with REST, GraphQL, and AsyncAPIs. +* Unlock collaborative innovation, long-term sustainability, enhanced security, and regulatory compliance. +* Strategically adopt modern service delivery and development paradigms without leaving behind the legacy systems that made you successful in the first place. + +### Advanced Integration Support -If you run on Kubernetes, we recommend you check our specific solution +The integration runtime supports creating composite microservices, message routing, transformation, message mediation, service orchestration, as well as consuming and processing streaming data. + +### Extensibility and Customizability + +WSO2 API Manager is a versatile and adaptable platform, capable of catering to the requirements of enterprises of all sizes, ranging from emerging startups to well-established businesses with decades of history. It presents user-friendly extension opportunities to tailor authenticators, policies, mediations, API lifecycles, workflows, portals, and login pages to your specific needs. Getting Started ============= @@ -27,65 +48,53 @@ Installation 1. This product requires a JDK to run. We support JDK from v17 through v21. Check our [supported JDKs](https://apim.docs.wso2.com/en/latest/install-and-setup/setup/reference/product-compatibility/#tested-operating-systems-and-jdks) documentation for a complete list. 2. Make sure you have set the `JAVA_HOME` environment variable to point to your JDK. See [this documentation](https://apim.docs.wso2.com/en/latest/install-and-setup/install/installing-the-product/installing-api-m-runtime/#setting-up-java_home) if you need help doing so. 3. Extract the wso2am-4.4.0.zip and go to the 'bin' directory -4. Run the api-manager.sh or api-manager.bat script based on you operating system. +4. Run the api-manager.sh or api-manager.bat script based on your operating system. 5. Access the respective WSO2 API-M interfaces - * API Publisher web application is running at: https://localhost:9443/publisher. + * **API Publisher** web application is running at: https://localhost:9443/publisher. You may sign in to the Publisher using the default administrator credentials (username: admin, password: admin). - * Developer Portal web application is running at: - https://localhost:9443/devportal \ + * **Developer Portal** web application is running at: - https://localhost:9443/devportal \ You may sign in to the Developer Portal using the default administrator credentials (username: admin, password: admin). ## Exposing your first API -Follow our [Quick Start guide ](https://apim.docs.wso2.com/en/latest/get-started/api-manager-quick-start-guide/) to expose and test your first API while getting familiar with our API designer and developer portal. +Follow our [Quick Start guide ](https://apim.docs.wso2.com/en/latest/get-started/api-manager-quick-start-guide/) to expose and test your first API while getting familiar with our API publisher and developer portal interfaces. Documentation ============== Online product documentation is available at: https://apim.docs.wso2.com/en/latest/ -Support -================================== - -WSO2 Inc. offers a variety of development and production support programs, ranging from Web-based support up through normal business hours, to premium 24x7 phone support. - -For additional support information please refer to the [WSO2 support page](https://wso2.com/support). - -Can you fill this survey ? -================================== +# Reporting Product Issues -WSO2 wants to learn more about our open source software (OSS) community and your communication preferences to serve you better. +All known issues of WSO2 API Manager are filed at: https://github.com/wso2/api-manager/issues. Please check this list before opening a new issue. -In addition, we may reach out to a small number of respondents to ask additional questions and offer a small gift. +Opening an issue +---------------------------------- -Link to survey: https://forms.gle/h5q4M3K7vyXba3bK6 +Help us make our software better! Submit any bug reports or feature requests through GitHub: https://github.com/wso2/api-manager/issues. +### Reporting Security Issues -Known Issues -================================== +Please **do not** report security issues via GitHub issues. Instead, follow the [WSO2 Security Vulnerability Reporting Guidelines](https://security.docs.wso2.com/en/latest/security-reporting/vulnerability-reporting-guidelines/). -All known issues of WSO2 API Manager are filed at: https://github.com/wso2/api-manager/issues +# Community Support -Please check this list before opening a new issue. +You can ask for help on [Stack Overflow](https://stackoverflow.com/questions/tagged/wso2-micro-integrator) and join our community on [Discord](https://discord.gg/wso2). -Opening an issue -================================== +# Commercial Support -Please submit any bug reports or feature requests through GitHub: https://github.com/wso2/api-manager/issues. +You can take advantage of a WSO2 on-prem product subscription for the full range of software product benefits needed in your enterprise, like expert support, continuous product updates, vulnerability monitoring, and access to the licensed distribution for commercial use. +To learn more, check [WSO2 Subscription](https://wso2.com/subscription/). -Crypto Notice +Can you fill this survey ? ================================== -This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. **Before** using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See for more information. - -The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. +WSO2 wants to learn more about our open source software (OSS) community and your communication preferences to serve you better. -The following provides more details on the included cryptographic software: +In addition, we may reach out to a small number of respondents to ask additional questions and offer a small gift. -* Apache Rampart : http://ws.apache.org/rampart/ -* Apache WSS4J : http://ws.apache.org/wss4j/ -* Apache Santuario : http://santuario.apache.org/ -* Bouncycastle : http://www.bouncycastle.org/ +Survey is available at: https://forms.gle/h5q4M3K7vyXba3bK6 -------------------------------------------------------------------------------- (c) Copyright 2024 WSO2 Inc.