IBM API Management V2.0 helps simplify your on-premise API management experience and utilize your existing IBM WebSphere DataPower Gateway appliances
IBM United States Software Announcement 213-148April 23, 2013
ENUS213-148.PDF| Table of contents | ||||||||||||||||||||||
|
(Corrected on August 7, 2013)
The Hardware requirements section was revised.
(Corrected on April 30, 2013)
The date for the Availability of National Languages was changed to June 28, 2013.
|
| At a glance |
 |
API Management is a complete solution that helps you:
- Quickly register and configure your API management solution within minutes 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
For ordering, contact your IBM representative, an IBM Business Partner, or IBM Americas Call Centers at 800-IBM-CALL (Reference: YE001).
Back to top
|
|
| Overview |
|
Markets continue to change at a rapid pace. The expansion of the number of devices, such as smartphones, tablets, laptops, and so on as well as the growth of social media is presenting new and additional business opportunities for companies to create new channels with their customers and partners. To address these emerging opportunities, companies are opening up their data and services by exposing them as web APIs. A web 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.
Today, IBM is announcing IBM API Management, a complete set of web API capabilities that can be deployed on-premise in an enterprise's data center. API Management integrates 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 provides capabilities for creating, proxying, assembling, securing, and scaling the web 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 is available with self-service registration and provides links to social communities.
API Management complements the Software as a Service (SaaS)-based web API capabilities offered with IBM WebSphere® Cast Iron® Live Web API Services, but as an on-premise solution. Also, with the on-premise solution, you can now use your existing WebSphere DataPower® Gateway Appliances running firmware Version 6.0 to act as the API gateway.
API Management key benefits
API Management is a complete solution that offers critical web API capabilities, including:
- Rapid API proxying and assembly: API assembly and proxying capabilities are provided to 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 IBM WebSphere Cast Iron .
- 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 using a combination of API key and secret, 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 are provided to help you analyze how your company's products are utilized and how well the APIs are performing and being used by developers.
- Ability to import existing APIs: The API provider can derive Representational State Transfer (REST)-based APIs from existing enterprise services or combinations of services such as SOAP-based web services or relational database sources.
- Nurturing of innovation: The developer community can help the innovative application developers, whether they are internal or external, to develop applications. This can expand a business's brand loyalty and open new channels of business to attract existing partners.
- Securely integrate with IBM DataPower Gateway: API Management requires and integrates with IBM DataPower Gateway Appliances, which contain robust security capabilities and provides access control, integration, and optimized delivery of APIs and other enterprise resources.
Back to top
|
|
| Key prerequisites |
|
For details, refer to the Hardware requirements and Software requirements sections.
Back to top
|
|
| Planned availability date |
|
- June 28, 2013: (Electronic distribution) - US English and national languages
- July 12, 2013: (Media packs) - US English and national languages
Back to top
|
|
| Description |
|
Today's dynamic business environments and economic uncertainties create a need for the organizations to work smarter in order to remain competitive and respond to changing demands for better and newer products and services at lower costs. Working smarter means having the agility to take advantage of new revenue opportunities and address competitive threats. It also means being able to optimize costs by lowering operational and maintenance expenses while increasing efficiency.
For many businesses, a primary barrier to business agility and cost optimization is IT complexity. To achieve business goals, IT must be able to quickly and easily deliver on the needs of the business while supporting innovation. API Management helps companies quickly orchestrate and create new web APIs, secure and manage the web APIs, gain business insight with analytics, socialize the web APIs in communities, and integrate their cloud services with on-premise applications and enterprise systems.
IBM offers a solution with IBM 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
The on-premise offering of IBM API Management offers a solution for companies and businesses to establish API management for their private, internal APIs, as well as public or protected, external APIs. This new on-premise offering provides the capabilities needed to externalize and manage your services as web APIs. With it, you can also use your existing DataPower Gateway Appliances running at a minimum firmware level of V6.0, which provides security capabilities, threat protection, traffic management, and optimized delivery of API workloads.
API Management delivers the following sets of capabilities in these focused areas:
- Create and manage APIs to help reduce time to market and simplify operational management of the API
- Dynamic and highly-available API versioning capabilities
- Snapshot the implementation with the ability to revert to previous state
- Create new REST APIs from SOAP-based services
- Support standard security mechanisms for API management such as OAuth and Basic Auth with a simplified user experience
- Provide enhanced and detailed operational metrics
- Manage APIs from a business perspective
- Support detailed analytics to support billing capabilities
- Support expanded entitlement policies
- Enhancements in analytics
- Simplify and scale operations management experiences for an on-premise private cloud
- Small, minimal footprint to get started
- Easy-to-use operations dashboard for management activities
- Critical API security, control, and optimization capabilities delivered by IBM DataPower Gateway Appliances
- Provides high-performing, scalable, and dynamically managed API gateway that is fully integrated with the API Management Administration and Developer Portals
- Provides policy enforcement point (PEP) for API access and traffic management
- Efficiently performs message payload processing and protocol conversions for integrating with existing company services and assets
- Optionally utilize API assembly capabilities of IBM WebSphere Cast Iron for the rapid deployment of new APIs
- Enables rapid creation of new APIs from existing business assets or cloud services through a no-coding configuration-based approach
- Allows you to create APIs based on SOAP-to-REST conversions, access to relational databases ( IBM DB2® , Microsoft™ SQL Server, MySQL, and Oracle), access to salesforce.com, or by orchestrating an API implementation from multiple data sources
- Defines human-readable error messages that an API can return, making it easier for your application developers to work with your API
- Offers improved debugging capabilities that enable the API provider to understand and navigate both simple and complex assembly scenarios to troubleshoot errors and issues
- Supports arrays and collections in the API assembly, enabling more complex assemblies and more formats in the API response messages
Back to top
|
|
| Reference information |
|
For information on IBM WebSphere DataPower Appliance V6.0, refer to Software Announcement 213-172, dated April 23, 2013 .
For information on WebSphere Cast Iron Appliance XH40 firmware V6.4, refer to Hardware Announcement 113-083, dated April 23, 2013 .
For information on WebSphere Cast Iron Hypervisor Edition V6.4, refer to Software Announcement 213-185, dated April 23, 2013 .
Back to top
|
|
| Availability of national languages |
|
Description Availability date Language
5725-L30 June 28, 2013 Multilingual -
(Chinese Simplified,
Chinese Traditional,
English US,
French,
German,
Italian,
Japanese,
Korean,
Portuguese-Brazilian
Spanish)
Back to top
|
|
| Program number |
|
Program Program number VRM name 5725-L30 V2.0.0 IBM API Management
Back to top
|
|
| Education support |
|
Education support will be provided for the products in this announcement.
IBM Global Services, IT Education Services, supports many IBM offerings.
Flexible training options
WebSphere education offers several training options to meet your budget and time goals. Many offerings are delivered in a traditional classroom setting, at either your location or an IBM training center. Online delivery options are also available. Instructor-led online classes are taught real-time by an IBM instructor in a virtual classroom setting. Or, for a more independent training experience, you can select from a wide variety of self-paced online courses that you complete on your schedule.
For more information about available WebSphere education offerings, including course locations and availability dates, visit
Role-based training paths can be found at
For additional IBM education, visit
Call IBM training at 800-IBM-TEACH (426-8322) for catalogs, schedules, and enrollments.
Back to top
|
|
| Offering Information |
|
Product information is available via the Offering Information website
Also, visit the Passport Advantage® website
Back to top
|
|
| Publications |
|
API Management publications will be available on June 28, 2013, in the online Information Center. Visit
Back to top
|
|
| Technical information |
|
Specified operating environment
Hardware requirements
One of the following IBM DataPower Gateway Appliances is required for use with IBM API Management. The DataPower Appliance must be running a minimum firmware level of V6.0:
- IBM WebSphere DataPower Integration Appliance XI52
- IBM WebSphere DataPower Service Gateway XG45
- IBM WebSphere DataPower Integration Appliance XI50
- IBM WebSphere DataPower Integration Blade XI50B
- IBM WebSphere DataPower Integration Appliance XI52 Virtual Edition
- IBM WebSphere DataPower Service Gateway XG45 Virtual Edition
The following DataPower software features are required for use with IBM API Management:
- Application Optimization
- Data Integration Module, when using the DataPower XG45 or DataPower XG45 Virtual Edition
One of the following is required for use with IBM API Management to take advantage of the rich API assembly feature:
- IBM WebSphere DataPower Cast Iron Appliance XH40 firmware V6.4
- IBM WebSphere Cast Iron Hypervisor Edition V6.4
The API assembly feature allows you to create APIs based on SOAP-to-REST conversions, access to relational databases ( IBM DB2 , Microsoft SQL Server, MySQL, and Oracle), access to salesforce.com, or by orchestrating an API implementation from multiple data sources. The Cast Iron Appliance must be running a minimum firmware level of V6.4.
The most current hardware requirements for IBM API Management will be available after April 29, 2013, at
For information on IBM WebSphere DataPower Appliances firmware V6.0, refer to Software Announcement 213-172, dated April 23, 2013 .
For information on IBM WebSphere DataPower Service Gateway XG45 and WebSphere DataPower Integration Appliance XI52 Virtual Editions, refer to Software Announcement 213-172, dated April 23, 2013 .
Software requirements
IBM API Management requires:
- One of the following browsers:
- Microsoft Internet Explorer V9
- Mozilla Firefox 17
- Google Chrome 23
- One of the following hosting environments:
- VMWare ESXi 4.1
- IBM Workload Deployer 3.1.0.7
- IBM PureApplication™ System W1500 1.0.0.4
The most current software requirements for IBM API Management V2.0 will be available after April 29, 2013, at
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 set of physical media packs consisting of multiple DVDs.
- License Information document, form number L-SBRY-95CFW7
Back to top
|
|
| Software Services |
|
IBM Software Services has the breadth, depth, and reach to manage your services needs. You can leverage the deep technical skills of our lab-based, software services team and the business consulting, project management, and infrastructure expertise of our IBM Global Services team. Also, we extend our IBM Software Services reach through IBM Business Partners to provide an extensive portfolio of capabilities. Together, we provide the global reach, intellectual capital, industry insight, and technology leadership to support a wide range of critical business needs.
To learn more about IBM Software Services or to contact a Software Services sales specialist, visit
Back to top
|
|
| Ordering information |
|
This product is only available 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 V2.0 5725-L30
Product category: Application Integration Middleware Other
Program
Product number
IBM API Management V2.0 5725-L30
Passport Advantage
IBM API Management
Part
Program name/Description number
IBM API Management Administration
and Developer Portal
per Processor Value Unit
License and Software Maintenance 12 mo D0ZSZLL
Annual Software maintenance renewal E0HP6LL
Software Maintenance reinstatement 12 mo D0ZT0LL
IBM API Management Administration
and Developer Portal for non-production
per Processor Value Unit
License and Software Maintenance 12 mo D0ZT1LL
Annual Software maintenance renewal E0HP7LL
Software Maintenance reinstatement 12 mo D0ZT2LL
Notes :
- IBM WebSphere Cast Iron API assembly capabilities can be used as an alternative for the rapid deployment of new APIs.
- API Management requires an IBM WebSphere DataPower 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 V2.0 multilingual - Media pack BA16SML
Charge metric
IBM 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 cores1 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
- 1
- 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.
Back to top
|
|
| 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 only available via Passport Advantage . It is not available as shrinkwrap.
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 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 form number
Program name LI number IBM API Management V2.0 L-SBRY-95CFW7
The programs' 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 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 restrictions
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
IBM Operational Support Services -- SoftwareXcel
No
Other support
Passport Advantage
System i® Software Maintenance applies
No
Variable charges apply
No
Educational allowance available
Not applicable.
Back to top
|
|
| 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.
Back to top
|
|
| Prices |
|
For additional information and current prices, contact your local 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.
Back to top
|
|
| Order now |
|
To order, contact the Americas Call Centers or your local IBM representative, or your IBM Business Partner.
To identify your local IBM representative or IBM Business Partner, call 800-IBM-4YOU (426-4968).
Phone: 800-IBM-CALL (426-2255)
Fax: 800-2IBM-FAX (242-6329)
Internet: callserv@ca.ibm.com
Mail: IBM Teleweb Customer Support
ibm.com® Sales Execution Center, Americas North
3500 Steeles Ave. East, Tower 3/4
Markham, Ontario
Canada
L3R 2Z1
Reference: YE001
The Americas Call Centers, our national direct marketing organization, can add your name to the mailing list for catalogs of IBM products.
Note: Shipments will begin after the planned availability date.
IBM Software Value Plus
These products are available under IBM Software Value Plus, either directly from IBM or through authorized Business Partners who invest in skills and high value solutions. IBM customers may benefit from the industry-specific or horizontal solutions, skills, and expertise provided by these Business Partners.
Additions to Software Value Plus will be communicated through standard product announcements. For a current list of IBM software available under Software Value Plus, visit
For questions regarding Software Value Plus, visit
http://www.ibm.com/partnerworld/page/svp_authorized_portfolio_contacts
Trademarks
PureApplication is a trademark of IBM Corporation in the United States, other countries, or both.
IBM, WebSphere, Cast Iron, DataPower, DB2, Passport Advantage, Express, System i and ibm.com 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. 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
