IBM API Management V3.0 helps organizations easily promote business services as APIs to internal and external developer communities, while providing a self-service developer experience
IBM Europe, Middle East, and Africa Software Announcement ZP14-0176April 22, 2014
|
At a glance |
IBM® API Management V3.0 delivers these key capabilities:
- Application programming interface (API) developer can create, secure, control, deploy, analyze, and manage SOAP and REST APIs and services for internal or external consumption quickly through a single console.
- API business owner can advertise, market, socialize, and sell APIs as a product in developer communities (private, partner, and public) worldwide.
- Application developers can easily find, understand, and have tools to help them consume the API, and are able to manage their application and understand its consumption.
- IT operations can easily manage and upgrade the API environment to use existing investments in DataPower® with the ability to monitor and scale without disruption to service.
API Management is a complete solution that helps you:
- Quickly configure your API management solution and rapidly create new APIs from existing business assets or cloud services through configuration and a no-coding approach.
- Manage your APIs with business-level controls by setting varying levels of consumption entitlements and the ability to manage the application developer.
- Transform and grow your business with insights through detailed analytics with structured filtered searches and navigation capabilities.
- Acquire partners and innovative application developers, both internally and externally, through an attractive developer portal that can be tailored to your brand.
- Use leading standard industry practices to help secure, control, and optimize access to your APIs.
- Reduce resolution time with supplied operational monitoring and debugging capabilities.
|
Overview |
To be a successful business and provide increased value to clients, employees, citizens, members, or patients, you need to continue to innovate while achieving cost optimization. To innovate while optimizing costs, you have an opportunity to expose key business services to business partners to drive new forms of collaboration, increase revenue opportunities, and provide higher value services to your customers. You can also expose your internal services to your internal developer communities, to drive application development consistency, reduce IT costs, and promote standard use of enterprise-approved services across your organization.
The expansion of the number of mobile devices, such as smartphones and tablets, as well as the growth of social media presents new and additional business opportunities to create new channels with customers and partners. To address these emerging opportunities, you require easy-to-use tools to define, assemble, secure, limit, and monitor services, while providing a self-service experience for rapid developer onboarding.
Business services are exposed with APIs. An API management solution is imperative to the success of externalizing the core services by providing easy assembly of new APIs, enabling security and different levels of service, providing management and insight to developers and business users, and socializing those APIs to developers, through communities and portals. This enables organizations to participate in the API economy, with rapid, highly secure connections between API providers and API consumers.
This new release of API Management delivers a complete set of management capabilities that can be deployed on-premise in an enterprise's data center. API Management V3.0 allows businesses as API providers, to integrate the most important features that are necessary to enable the three most significant players in the API economy: application developers, business owners, and IT personnel.
API Management V3.0 provides capabilities for creating, proxying, assembling, securing, and scaling the APIs. This solution also provides detailed analytics and operational metrics to the business owner and a customizable developer portal to socialize the APIs and manage applications that can be used by the developers. The developer portal enables self-service registration and provides links to social communities. API Management V3.0 requires IBM WebSphere® DataPower gateway appliances with a minimum firmware level of V6.0.0.4 to act as the API gateway. These DataPower appliances can be either physical or virtual appliances.
API Management key benefits
API Management is a complete solution that offers critical API and service management features, that include:
- Managed self-service: Rapid, secure, and dynamic onboarding of application developers who use APIs and services with a complete self-service, developer experience.
- Empowered developers: Developers can register their application, select API entitlement levels, and monitor their API usage.
- Visibility: Monitor use of APIs and services, and charge back developers for API usage.
- Rapid API proxying and assembly: API assembly and proxying capabilities allow rapid creation of new APIs from existing business assets or cloud services through configuration. These API assembly capabilities are enabled by seamless integration with WebSphere DataPower appliances.
- Support for iterative development and API versioning: Changes can be made dynamically to an existing API implementation. Reactivating new versions of the API can be performed in a nondisruptive, highly available manner.
- Security and robust scalability capabilities: Access to APIs can be managed by using a combination of API keys and secret keys, and application users can be authenticated using HTTP basic authentication or OAuth 2.0. The solution provides built-in caching, quota management, and flood control, and can be configured to exploit existing DataPower appliances.
- Business analytics and operational metrics: Detailed business analytics and operational metrics help you analyze how your company's products are utilized. You can also view how well the APIs are performing and are being used by developers.
- Ability to import existing APIs and Simple Object Access Protocol (SOAP)-based web services: The API provider can derive Representational State Transfer (REST)-based APIs by assembling REST and SOAP based services. The API provider can also discover web services from WebSphere Service Registry and Repository (WSRR).
- Ability to nurture innovation: The developer community can help the innovative application developers, whether they are private, partner, or public, to develop applications. This can expand a business's brand loyalty and open new channels of business to attract existing partners.
- Highly secure API support that is provided by IBM DataPower gateway: API Management requires and integrates with DataPower gateway appliances, which enables integration of API, web, mobile, SOA, and B2B workloads in a single, highly secure, highly consumable physical or virtual appliance.
|
Key prerequisites |
API Management requires a supported:
- DataPower gateway appliance (physical or virtual)
- Web browser
- Hosting environment
For more details, refer to the Hardware requirements and Software requirements sections.
|
Planned availability date |
- Support for VMware:
- May 9, 2014: Electronic distribution - US English and national languages
- May 23, 2014: Media packs - US English and national languages
- Support for IBM PureApplication Systems and Xen:
- June 13, 2014: Electronic distribution - US English and national languages
- June 27, 2014: Media packs - US English and national languages
Availability of programs with encryption algorithm in France is subject to French government approval.
Refer to the Availability of national languages section for national language availability.
|
Description |
To be a successful business and provide increased value to clients, employees, citizens, members, or patients, you need to continue to innovate while achieving cost optimization. To innovate while optimizing costs, you have an opportunity to expose key business services to business partners to drive new forms of collaboration, increase revenue opportunities, and provide higher value services to your customers. You can also expose your internal services to your internal developer communities, to drive application development consistency, reduce IT costs, and promote the standard use of enterprise-approved services across your organization.
The expansion of the number of mobile devices, such as smartphones and tablets, as well as the growth of social media presents new and additional business opportunities to create new channels with customers and partners. To address these emerging opportunities, you require easy-to-use tools to define, assemble, secure, limit, and monitor services, while providing a self-service experience for rapid developer onboarding.
Business services are exposed with APIs. An API management solution is imperative to the success of externalizing the core services that:
- Offer easy assembly of new APIs
- Enable security and different levels of service
- Provide management and insight to developers and business users
- Socialize the APIs to developers, through communities and portals
This enables organizations to participate in the API economy, with rapid, highly secure connections between API providers and API consumers.
IBM offers a solution with API Management to enable businesses to create, socialize, and manage their APIs. This solution can help you:
- Grow your business by entering the fastest growing business channel of APIs quickly
- Increase speed of innovation by sourcing developers, both internally and externally
API Management offers a solution for companies and businesses to expose APIs to their private, internal developers, partner developers, as well as public developers. This on-premise offering provides the capabilities needed to externalize and manage your services as web APIs. API Management requires DataPower gateway appliances (physical or virtual) running at a minimum firmware level of V6.0.0.4. The API gateway provides API security, control, and optimization capabilities for the API workloads.
API Management V3.0 delivers the following sets of capabilities:
- API developer can create, secure, control, deploy, analyze, and manage SOAP and REST APIs and services for internal or external consumption quickly through a single console.
- Policy-driven assembly that enables custom rate-limiting scenarios, enforced by the API gateway (DataPower)
- Fine-grained ability to set API quotas and rate limits
- Visibility and control with ability to deploy across runtime environments
- Ability to easily create different versions of an API and understand where those versions are deployed, such as in test, staging, or production
- Ability to search for, add custom labels to, and mark favorite APIs and services for easier discovery in API Manager to work with APIs
- Ability to notify within API Manager to understand who is working on the APIs and any issues the APIs might be having
- Support for SOAP-based web services
- Discovery of web services from WSRR
- Ability to create an API by assembling REST-based and SOAP-based services
- Role-based access for viewing and working with the APIs
- Support for OAuth 2.0, an open standard for authorization
- API business owner can advertise, market, socialize, and sell APIs as a product in developer communities worldwide:
- Ability to have more than one developer portal in order to support more than one developer community (private, partner, and public), with controlled visibility
- Ability to create API plans that treat the APIs as product offerings, and allow several APIs and resources per plan
- Improved application developer management, with the ability to send an email to all application developers in a particular community
- Application developer (also API consumer) can explore API documentation and provision application keys:
- Developers can register their application, select API entitlement levels, and monitor their API usage.
- A single ID allows a developer to be a member of multiple API Management communities.
- Allows role-based access for viewing APIs.
- IT operations can easily manage and upgrade the API environment using existing investments in DataPower with the ability to monitor and scale without disruption to service:
- Simplified operations environment for API assembly using DataPower gateway
- Improved environment console experience
- Improved tenant management with the introduction of organization and owners
- Integration with enterprise authentication systems by using Lightweight Directory Access Protocol (LDAP) that enables administrators to streamline the user login process
- Simplification of deployment architecture to only two tiers:
- Gateway tier - DataPower appliance (virtual or physical appliance)
- Management tier - API Management virtual appliance
|
Statement of direction |
IBM intends to introduce a software as a service (SaaS) offering of API Management. This cloud-based offering is intended to help businesses extend their reach beyond the enterprise to internal and external application developers, by enabling rapid orchestration and design of new APIs, securing and managing the APIs, gaining business insight with analytics, and socializing the APIs in developer communities.
IBM's statements regarding its plans, directions, and intent are subject to change or withdrawal without notice at IBM's sole discretion. Information regarding potential future products is intended to outline our general product direction and it should not be relied on in making a purchasing decision. The information mentioned regarding potential future products is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. Information about potential future products may not be incorporated into any contract. The development, release, and timing of any future features or functionality described for our products remain at our sole discretion.
|
Reference information |
For information on IBM WebSphere DataPower Appliance V6.0, refer to Software Announcement ZP13-0213, dated April 23, 2013.
For information on WebSphere DataPower B2B Appliance XB62, refer to Software Announcement ZP13-0740, dated December 10, 2013.
For information on IBM WebSphere DataPower Integration Blade XI50B, refer to Software Announcement ZP10-0138, dated April 27, 2010.
For information on WebSphere DataPower Service Gateway XG45 and WebSphere DataPower Integration Appliance XI52 Virtual Editions, refer to Software Announcement ZP13-0161, dated March 26, 2013.
|
Availability of national languages |
Description Availability date Language 5725-L30 05/23/2014 Multilingual - (Chinese Simplified, Chinese Traditional, English US, French, German, Italian, Japanese, Korean, Portuguese-Brazilian Spanish)
|
Program number |
Program Program number VRM name 5725-L30 V3.0.0 IBM API Management
|
Education support |
Education is a key component to ensuring software success. IBM creates a comprehensive portfolio of education material to help customers successfully deploy IBM software products to their maximum potential. The IBM education team is committed to providing the highest quality education content available to help your organization prosper in today's competitive marketplace.
The IBM education team works closely with IBM product developers and IBM services organizations to ensure that the courses we offer provide the most current technical and product information. Our courses place an emphasis on the advanced knowledge and insight that only these sources can provide. We draw from a deep pool of IBM technical experience in the development of our courses, and pass that knowledge on to our students. Our courses emphasize hands-on labs to develop comprehensive skills in using the product to solve business problems. The education offerings from IBM Training span the spectrum of skill needs, from introductory product overviews to advanced programming and product administration courses.
Role-based, training paths can be found at
The delivery of IBM education is provided by IBM Global Training Partners.
For more information about available education offerings, search on the product name at
For building skills for a smarter planet, visit
|
Offering Information |
Product information is available via the Offering Information website
Also, visit the Passport Advantage® website
|
Publications |
API Management publications will be available on May 9, 2014, on the online IBM Knowledge Center at
|
Technical information |
Specified operating environment
Hardware requirements
API Management V3.0 requires WebSphere DataPower gateway appliances with a minimum firmware level of V6.0.0.4 to act as the API gateway. These DataPower appliances can be either physical or virtual appliances and can be any of the following:
- WebSphere DataPower Integration Appliance XI52
- WebSphere DataPower Service Gateway XG45
- WebSphere DataPower B2B Appliance XB62
- WebSphere DataPower Integration Blade XI50B
- WebSphere DataPower Integration Appliance XI52 Virtual Edition
- WebSphere DataPower Service Gateway XG45 Virtual Edition
The following DataPower software feature is required and included for use with API Management:
- Application optimization
The most current hardware requirements for API Management V3.0 are available at
Type "API Management" in the "Full or partial product name" box, then select "V3.0" in the "Version" box.
Software requirements
API Management requires these minimum levels:
- One of the following browsers:
- Microsoft Internet Explorer V9
- Mozilla Firefox 24
- Google Chrome 30
- Safari 5.1.10, 6.1, or 7.0
- One of the following hosting environments:
- VMware ESXi 5.0
- VMware vCenter V5.5
- Citrix XenServer 6.2
- IBM PureApplication System W1500 1.1
- For SOAP Service discovery from WSRR, the following minimum product and release is required:
- WSRR V7.0
The most current software requirements for API Management V3.0 are available at
Type "API Management" in the "Full or partial product name" box, then select "V3.0" in the "Version" box.
The program's specifications and specified operating environment information may be found in documentation accompanying the program, if available, such as a readme file, or other information published by IBM, such as an announcement letter. Documentation and other program content may be supplied only in the English language.
Planning information
Packaging
- API Management is distributed via electronic download and a single physical media pack consisting of multiple DVDs.
- License Information document - L-SBRY-9ALF9L
This program, when downloaded from a website, contains the applicable IBM license agreement and License Information, if appropriate, which will be presented for acceptance at the time of installation of the program. For future reference, the license and License Information will be stored in a directory such as LICENSE.TXT.
Global Technology Services®
Contact your IBM representative for the list of selected services available in your country, either as standard or customized offerings, for the efficient installation, implementation, or integration of this product.
|
Ordering information |
This product is available only via Passport Advantage. It is not available as shrinkwrap.
These products may only be sold directly by IBM or by authorized IBM Business Partners for Software Value Plus.
For more information about IBM Software Value Plus, visit
To locate IBM Business Partners for Software Value Plus in your geography for a specific Software Value Plus portfolio, visit
API Management
Product group: WebSphere Program Product Identifier Description number IBM API Management V3.0 5725-L30 Product category: Application Integration Middleware Other
For ordering information, consult your IBM representative or authorized IBM Business Partner, or visit
Passport Advantage
Part number information remains unchanged. Refer to API Management V2.0 Software Announcement ZP13-0183, dated April 23, 2013.
Note: API Management V3.0 requires an IBM WebSphere DataPower physical or virtual appliance as the API gateway to offer API security, control, and optimization capabilities.
Passport Advantage customer: Media pack entitlement details
Customers with active maintenance or subscription for the products listed are entitled to receive the corresponding media pack.
Media pack description Part number API Management V3.0 multilingual - Media pack BA185ML
Charge metric
API Management (Passport Advantage)
Program Charge unit Program/service name number description IBM API Management 5725-L30 Per processor Value Unit (PVU)
Processor Value Unit (PVU)
PVU is a unit of measure by which the program can be licensed. The number of PVU entitlements required is based on the processor technology (defined within the PVU table by processor value, brand, type, and model number at the website below) and the number of processors made available to the program. IBM continues to define a processor, for the purpose of PVU-based licensing, to be each processor core on a chip. A dual-core processor chip, for example, has two processor cores. The PVU table can be found at
Licensee can deploy the program using either full capacity licensing or virtualization capacity (sub-capacity) licensing according to the Passport Advantage Sub-Capacity Licensing Terms (refer to the web page below). If using full capacity licensing, licensee must obtain PVU entitlements sufficient to cover all activated processor cores* in the physical hardware environment made available to or managed by the program, except for those servers from which the program has been permanently removed. If using virtualization capacity licensing, licensee must obtain entitlements sufficient to cover all activated processor cores made available to or managed by the program, as defined according to the Virtualization Capacity License Counting Rules at
* An activated processor core is a processor core that is available for use in a physical or virtual server, regardless of whether the capacity of the processor core can be or is limited through virtualization technologies, operating system commands, BIOS settings, or similar restrictions.
Notes :
- Some programs may require licenses for the program and what is being managed. In that case, the following applies. In addition to the entitlements required for the program directly, licensee must obtain PVU entitlements for this program sufficient to cover the processor cores managed by the program.
- Some programs may be licensed on a managed basis only. In that case, the following applies. Instead of the entitlements required for the program directly, licensee must obtain PVU entitlements for this program sufficient to cover the processor cores managed by the program.
- A few programs on an exception basis may be licensed on a referenced basis. In that case, the following applies. Rather than obtaining entitlements for the activated processor cores available to the program, licensee must obtain PVU entitlements for this program sufficient to cover the environment made available to the referenced program as if the program itself were executing everywhere the referenced program was executing, independent of the basis on which the referenced program is licensed.
|
Terms and conditions |
The information provided in this announcement letter is for reference and convenience purposes only. The terms and conditions that govern any transaction with IBM are contained in the applicable contract documents such as the IBM International Program License Agreement, IBM International Passport Advantage Agreement, and the IBM Agreement for Acquisition of Software Maintenance.
This product is available only via Passport Advantage.
Licensing
IBM International Program License Agreement including the License Information document and Proof of Entitlement (PoE) govern your use of the program. PoEs are required for all authorized use. Part number products only, offered outside of Passport Advantage, where applicable, are license only and do not include Software Maintenance.
These programs are licensed under the IBM Program License Agreement (IPLA) and the associated Agreement for Acquisition of Software Maintenance, which provide for support with ongoing access to releases and versions of the program. IBM includes one year of Software Subscription and Support (also referred to as Software Maintenance) with the initial license acquisition of each program acquired. The initial period of Software Subscription and Support (also referred to as Software Maintenance) can be extended by the purchase of a renewal option, if available. These programs have a one-time license charge for use of the program and an annual renewable charge for the enhanced support that includes telephone assistance (voice support for defects during normal business hours), as well as access to updates, releases, and versions of the program as long as support is in effect.
License Information number
L-SBRY-9ALF9L
The program's License Information will be available for review on the IBM Software License Agreement website
Limited warranty applies
Yes
Limited warranty
IBM warrants that when the program is used in the specified operating environment, it will conform to its specifications. The warranty applies only to the unmodified portion of the program. IBM does not warrant uninterrupted or error-free operation of the program or that IBM will correct all program defects. You are responsible for the results obtained from the use of the program.
IBM provides you with access to IBM databases containing information on known program defects, defect corrections, restrictions, and bypasses at no additional charge. For further information, consult the IBM Software Support Handbook found at
IBM will maintain this information for at least one year after the original licensee acquires the program (warranty period).
Program technical support
Technical support of a program product version or release will be available for a minimum of five years from the general availability date, as long as your Software Subscription and Support (also referred to as Software Maintenance) is in effect. This technical support allows you to obtain assistance (via telephone or electronic means) from IBM for product-specific, task-oriented questions regarding the installation and operation of the program product. Software Subscription and Support (Software Maintenance) also provides you with access to updates (modifications or fixes), releases, and versions of the program. You will be notified, via announcement letter, of discontinuance of support with 12 months' notice. If you require additional technical support from IBM, including an extension of support beyond the discontinuance date, contact your IBM representative or IBM Business Partner. This extension may be available for a fee.
Money-back guarantee
If for any reason you are dissatisfied with the program and you are the original licensee, you may obtain a refund of the amount you paid for it, if within 30 days of your invoice date you return the program and its PoE to the party from whom you obtained it. If you downloaded the program, you may contact the party from whom you acquired it for instructions on how to obtain the refund.
For clarification, note that (1) for programs acquired under the IBM International Passport Advantage offering, this term applies only to your first acquisition of the program and (2) for programs acquired under any of IBM's On/Off Capacity on Demand (On/Off CoD) software offerings, this term does not apply since these offerings apply to programs already acquired and in use by you.
Volume orders (IVO)
No
Passport Advantage applies
Yes, and through the Passport Advantage website at
Usage restriction
Yes
For additional information, refer to the License Information document that is available on the IBM Software License Agreement website
Software Subscription and Support applies
Yes. Software Subscription and Support (also referred to as Software Maintenance) is included with licenses purchased through Passport Advantage and Passport Advantage Express®. Product upgrades and Technical Support are provided by the Software Subscription and Support offering as described in the Agreements. Product upgrades provide the latest versions and releases to entitled software and Technical Support provides voice and electronic access to IBM support organizations, worldwide.
IBM includes one year of Software Subscription and Support with each program license acquired. The initial period of Software Subscription and Support can be extended by the purchase of a renewal option, if available.
While your Software Subscription and Support is in effect, IBM provides you assistance for your routine, short-duration installation and usage (how-to) questions, and code-related questions. IBM provides assistance via telephone and, if available, electronic access, only to your information systems (IS) technical support personnel during the normal business hours (published prime shift hours) of your IBM support center. (This assistance is not available to your end users.) IBM provides Severity 1 assistance 24 hours a day, 7 days a week. For additional details, consult your IBM Software Support Handbook at
Software Subscription and Support does not include assistance for the design and development of applications, your use of programs in other than their specified operating environment, or failures caused by products for which IBM is not responsible under the applicable agreements.
For additional information about the International Passport Advantage Agreement and the IBM International Passport Advantage Express Agreement, visit the Passport Advantage website at
Other support
Passport Advantage
System i® Software Maintenance applies
No
Variable charges apply
No
Educational allowance available
Education allowance does not apply.
Education software allowance does not apply.
Special education prices are available for qualified customers through Passport Advantage.
|
Statement of good security practices |
IT system security involves protecting systems and information through prevention, detection, and response to improper access from within and outside your enterprise. Improper access can result in information being altered, destroyed, or misappropriated or can result in misuse of your systems to attack others. Without a comprehensive approach to security, no IT system or product should be considered completely secure and no single product or security measure can be completely effective in preventing improper access. IBM systems and products are designed to be part of a comprehensive security approach, which will necessarily involve additional operational procedures, and may require other systems, products, or services to be most effective. IBM does not warrant that systems and products are immune from the malicious or illegal conduct of any party.
|
Prices |
For all local charges, contact your IBM representative.
Business Partner information
If you are an IBM Business Partner -- Distributor for Workstation Software acquiring products from IBM, you may link to Passport Advantage Online for resellers where you can obtain Business Partner pricing information. An IBM ID and password are required.
Passport Advantage
For Passport Advantage information and charges, contact your IBM representative or authorized IBM Business Partner for Software Value Plus. Additional information is also available at
IBM Global Financing
IBM Global Financing offers competitive financing to credit-qualified customers to assist them in acquiring IT solutions. Offerings include financing for IT acquisition, including hardware, software, and services, from both IBM and other manufacturers or vendors. Offerings (for all customer segments: small, medium, and large enterprise), rates, terms, and availability can vary by country. Contact your local IBM Global Financing organization or visit
IBM Global Financing offerings are provided through IBM Credit LLC in the United States, and other IBM subsidiaries and divisions worldwide to qualified commercial and government customers. Rates are based on a customer's credit rating, financing terms, offering type, equipment type, and options, and may vary by country. Other restrictions may apply. Rates and offerings are subject to change, extension, or withdrawal without notice.
Financing from IBM Global Financing helps you preserve cash and credit lines, enables more technology acquisition within current budget limits, permits accelerated implementation of economically attractive new technologies, offers payment and term flexibility, and can help match project costs to projected benefits. Financing is available worldwide for credit-qualified customers.
|
Announcement countries |
All European, Middle Eastern, and African countries except Iran, Sudan, and Syria.
Trademarks
PureApplication is a trademark of IBM Corporation in the United States, other countries, or both.
IBM, DataPower, WebSphere, Passport Advantage, Global Technology Services, Express and System i are registered trademarks of IBM Corporation in the United States, other countries, or both.
Microsoft is a trademark of Microsoft Corporation in the United States, other countries, or both.
Other company, product, and service names may be trademarks or service marks of others.
Terms of use
IBM products and services which are announced and available in your country can be ordered under the applicable standard agreements, terms, conditions, and prices in effect at the time. IBM reserves the right to modify or withdraw this announcement at any time without notice. This announcement is provided for your information only. Reference to other products in this announcement does not necessarily imply those products are announced, or intend to be announced, in your country. Additional terms of use are located at
For the most current information regarding IBM products, consult your IBM representative or reseller, or visit the IBM worldwide contacts page