API for IBM Z Assets

IBM Z / © 2018 IBM Corporation
Offer API Channel for
your Z assets
Madhu B A
Vinit Kutty
IBM Z for the Digital Enterprise

Disclaimer
 IBM’s statements regarding its plans, directions, and intent are subject to change or withdrawal without
notice and 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
remains at our sole discretion.
 Performance is based on measurements and projections using standard IBM benchmarks in a controlled
environment. The actual throughput or performance that any user will experience will vary depending upon
many factors, including considerations such as the amount of multiprogramming in the user’s job stream, the
I/O configuration, the storage configuration, and the workload processed. Therefore, no assurance can be
given that an individual user will achieve results similar to those stated here
2IBM Z / © 2018 IBM Corporation

z/OS Connect EE
• Industries rely on mainframe for high volume transaction
processing, ultra secure data and running mission critical
applications.
• Clients have built application assets over the years around a set
of business critical , strategic assets bringing success to their
business.
• As systems of engagement (SoE) evolve, the need for multi-
speed IT model means that SoE and SoR (Systems of Record)
must work together harmoniously.
• As newer systems of engagements evolve, application
developers require ways to discover and use enterprise
services
• Cloud applications need to communicate by using simple, self-
describing payloads or APIs.
History of the application assets and the
opportunity

The History of APIs
• Constant evolution of interfaces that connected applications.
• Popularity of APIs as interface of choice by developers.
• By offering an API Channel to business critical applications, clients can realize newer opportunities.

z/OS Connect EEEvolution of integration with core
systems
Client/Server
Web/Desktop
Cloud, Mobile and
Internet of Things
Green screen
1970s
1980s
1990s
2000s
TODAY
Service Oriented
Architecture

z/OS Connect EE
Hybrid Integration: What is it?
Systems of Insight
Systems of Record
Hybrid
Integration
Mobile
API economy
IoT
Systems of
Engagement
• Personalized
• Situational
• Adaptive, cognitive
• Predictive
• Corrective
• Event driven
• Real time transaction
• Secure
• At the edge
• Contextual
• Omni channel
Growth OpportunitiesAsset Optimization

z/OS Connect EE
7
REST stands for Representational State Transfer.
An architectural style for accessing and updating data.
Typically using HTTP… but not all HTTP interfaces are “RESTful”.
Simple and intuitive for the end consumer (the developer).
HTTP
REST is an Architectural Style

z/OS Connect EE
Why is REST popular?
8
Ubiquitous Foundation It's based on HTTP, which operates on TCP/IP, which is a ubiquitous
networking topology.
Relatively Lightweight Compared to other technologies (for example, SOAP/WSDL), the
REST/JSON pattern is relatively light protocol and data model, which
maps well to resource-limited devices.
Relatively Easy
Development
Since the REST interface is so simple, developing the client involves
very few things: an understanding of the URI requirements (path,
parameters) and any JSON data schema.
Increasingly Common REST/JSON is becoming more and more a de facto "standard" for
exposing APIs and Microservices. As more adopt the integration
pattern, the more others become interested.
Stateless REST is by definition a stateless protocol, which implies greater
simplicity in topology design. There's no need to maintain, replicate or
route based on state.

z/OS Connect EE
What is Swagger?
9
It is more than just an API framework
Write Swagger
Swagger Editor allows API
developers to design their
swagger documents.
Read Swagger
Swagger UI allows API consumers
to easily browse and try APIs based
on Swagger Doc.
Consume Swagger
Swagger Codegen create stub code
to consume APIs from various
languages
There are a number of tools available to aid consumption:

z/OS Connect EEWhat is z/OS Connect EE?
Strategic solution for enabling natural REST APIs for z/OS assets in a unified manner
across different subsystems with integrated auditing, security and scalability

z/OS Connect EE
Liberty z/OS
z/OS Connect EE
server instance
SoR subsystems
CICS, IMS, WAS,
DB2, MQ, …
IBM 64-bit SDK for z/OS,
Java Technology Edition
V7.1.0 or V8.0.0
z/OS Explorer Aqua V3.0
z/OS Connect EE API
Editor
Windows, Linux or OS/X with
• IBM CICS Explorer V5.3
• IBM IMS Explorer for Development V3.2
• IBM Explorer for z/OS Aqua V3.0
Runtime Server
•Adds the ability to hosts APIs
•Integrates with multiple z subsystems
•Li erty + z/OS Conne t = instan e
•You may have multiple instances
Tooling Platform
• Integrates with an Eclipse 4.4 environments
• Defines APIs and generates SWAGGER 2.0
• Compose API mapping models
• Deploy APIs to runtime server
• Export API archive for other tools to deploy
1
2
IBM z/OS Connect Enterprise Edition
Two parts to every story

z/OS Connect EE
z/OS Connect EE V3
APIs to and from the
mainframe
Comprehensive subsystem
support and unified tooling
Point-and-click API
creation
• Create services to CICS and IMS using a common API Toolkit
• Support for applications with complex data structures
• New CICS Service Provider that uses IPIC (TCP/IP) protocol and supports multi-
container channels and cross LPAR connectivity
• Call external APIs from your mainframe applications with new API requester support
• Simple integration into enterprise API management solutions

Where do I start my API journey?
14

1. Reference a catalog of business rules
15

2. Look at the program flow
16

3. Follow the data
17

z/OS Connect EE
You’ve chosen a z/OS asset you want to expose as a RESTful endpoint.
Steps to Expose a z/OS Asset
Starting point

z/OS Connect EE
Install, set up, and start your new z/OS Connect EE server.
ibm.biz/zosconnect-start-server
ibm.biz/zosconnect-installation
1. Install z/OS Connect EE

z/OS Connect EE
For you to start mapping an API, z/OS Connect EE needs a representation of the underlying
z/OS asset: a Service Archive file (.sar file).
2. Create your service definition

z/OS Connect EEService projects and service creation
Import data
structure
1
2 Redact fields, rename
fields, and add
descriptions to fields to
make the service more
consumable for an API
developer
Specify connection
reference and
transaction id for
service.
3
z/OS Connect EE V3
API Toolkit
Import the data structure,
define the service interface
and configure the service
IBM Explorer for z/OS
Aqua V3.1

z/OS Connect EE
Import your .sar file into the API Editor, and start designing your API.
From the editor, create an API Archive file (.aar), which describes your API and how it maps
to underlying services. ibm.biz/zosconnect-create-api
3. Create your API

z/OS Connect EE
Compose the
API URI path
Select the HTTP verb,
and map the call to
the underlying
service
Use the "Mapping"
function to assign static
values, remove fields
from client view, or
move values to a field
Define the URI path, http verbs and JSON
mappings for the API
1
3
2
API projects and API creation
z/OS Connect EE V3
API Toolkit
IBM Explorer for z/OS
Aqua V3.1

z/OS Connect EE
Configure the system-appropriate service provider to connect to your backend system in your
server.xml.
ibm.biz/zosconnect-configuring
4. Configure your service provider
© 2016 IBM
Corporation

z/OS Connect EE
(This step uses the artefacts generated with the .sar file in Step 2.)
Deploy the JSON schema and bind files generated by the service definition utility to zFS. Configure the service
definition in your server.xml.
ibm.biz/zosconnect-define-services
5. Deploy your service
© 2016 IBM
Corporation

z/OS Connect EE
Deploy your API using the right-click deploy in the API Editor,
or by copying the .aar file to the drop-ins folder.
ibm.biz/zosconnect-deploy-api
6. Deploy your API
© 2016 IBM
Corporation

z/OS Connect EE
API deployment with z/OS Connect V3
Backend Program
Source of copy book and
target of invocation
* Catalogue COMMAREA structure
03 CA-REQUEST-ID PIC X(6).
03 CA-RETURN-CODE PIC 9(2) DISPLAY.
03 CA-RESPONSE-MESSAGE PIC X(79).
* Fields used in Inquire Single
03 CA-INQUIRE-SINGLE.
05 CA-ITEM-REF-REQ PIC9(4) DISPLAY.
05 FILLER PIC 9(4) DISPLAY.
05 FILLER PIC 9(3) DISPLAY.
05 CA-SINGLE-ITEM.
07 CA-SNGL-ITEM-REF PIC9(4) DISPLAY.
07 CA-SNGL-DESCRIPTION PICX(40).
07 CA-SNGL-DEPARTMENT PIC 9(3) DISPLAY.
07 CA-SNGL-COST PIC X(6).
07 IN-SNGL-STOCK PIC 9(4) DISPLAY.
07 ON-SNGL-ORDER PIC 9(3) DISPLAY.
API Toolkit
Service Interface tooling
to extract JSON schema
from existing applications
z/OS Connect EE
V3 Server
Service
Definitions
API
Definition
3. Create API
5. Deploy
services
6. Deploy API
2. Create Services
4.
Configure
service
provider
API Editor to create the
desired API
1. Install and
configure z/OS
Connect EE V3

z/OS Connect EE
Your API is ready to be consumed: go tell your developers!
Done.
© 2016 IBM
Corporation

z/OS Connect EE
The API is the interface you expose to API requestors
POST
http://<host>:<port>/zosConnect/services/service_name?action=invoke
z/OS Connect EE V3 Service
Service
Provider
Backend Program
Target of invocation
For the CICS and IMS Service Providers the Service is also composed
with the API Toolkit. You can assign, remove and rename fields. Other
Service Providers provide utilities for creating service definitions.
You can invoke at the service level as a way to test and validate.
GET http://<host>:<port>/api_path?parm=value&parm=value
z/OS Connect EE V3 API
The API operation calls the configured service
The API definition is composed with the API Toolkit . You can map path
and query parameters , assign fields and remove unwanted fields.
API API
You may compose
multiple APIs that
invoke the same
service, each exposing
different data.
Services vs. APIs

IBM Z / © 2018 IBM
Corporation
Demo: Creating an API

z/OS Connect EE
API Consumption (API Requester)
• z/OS applications (CICS/IMS/batch) can call Swagger (Open API) defined RESTful APIs
• Supported HTTP methods - POST, PUT, GET, and DELETE
• Languages supported: COBOL or PL/1.
• Sample COBOL and PL/1 applications are supplied in the hlq.SBAQSAMP PDS library.

What happens when there is an issue with an API?
34

38
API enable Terminal based applications: HATS Integration
iSeries/zSerie
s
Integration Object
Java wrapper to
Macro
REST API
Map input/output
HATS Tooling (studio)
3270/5250
Stream Macro
Record
macro HATS
RESTful API
WAS/Liberty
HATS RuntimeDeploy
IBM Z /
iSeries
HATS Developer
.sar
zCEE
HATS
Deploy
zCEE Build toolkit
HATS swagger.json - i/o schema
HATS Runtime Server is
supported by zCEE via the
REST Service Provider
z/OS Connect EE
Server
Backend Systems
(CICS, IMS, DB, etc.)

z/OS Connect EEIBM z/OS Connect EE and Rocket Data
Virtualization
40
z/OS Connect
Enterprise Edition
CICS
IMS
WAS
MQ
DB2
RDV
WOLA
Mainframe
Applications
Mainframe
Data
RDV is a first-class z/OS
Connect Service
Provides RESTful APIs to z/OS
applications and data Rocket Data
Virtualization
All z/OS Data
--
Adabas, DB2
VSAM, IMS,
Physical
Sequential,
others
--
Non z/OS
Data
REST API
Consumers
A common interface for cloud,
mobile, web developers to z/OS
- no need for mainframe skills -

z/OS Connect EERecent features
42
[3.0.3] API toolkit adds the support for deploying services directly from your service project without having to export the project to a service
archive.
[3.0.4] You can also view all deployed services, examine service properties, update a service, and start and stop a service directly from within
the API toolkit
[3.0.1] Call external APIs from z/OS assets (CICS, IMS, and other z/OS applications)
[3.0.4] Oauth 2 support for API requestor
[3.0.0] API-enable more IBM z/OS applications
• Support for applications with complex data structures, such as REDEFINES and
OCCURS DEPENDING ON clauses in COBOL, and REFER option in PL/I.
• Support for COBOL and PL/I applications in IMS with large data structures that
go beyond traditional message segment limits.
[3.0.0] New IBM CICS Service Provider
• Support for multiple CICS containers, including any mix of BIT- and CHAR-type container.
• Exploits IP interconnectivity (IPIC) for cross-LPAR connectivity.
[3.0.0] z/OS Connect EE API toolkit (Eclipse tooling)
• Create and dynamically deploy service artefacts (.sar files) for CICS and IMS.
• Rename, redact, and add descriptions to data fields in services.
[3.0.0] Support for > 32K data structures with IMS

z/OS Connect EE
What is API Connect?
An integrated creation, runtime, management, and security
foundation for enterprise grade API’s and Microservices to
power modern digital applications
What does API Connect provide?
• Automated, visual and coding options for creating APIs
• Node.js and Java support for creating Microservices
• Integrated enterprise grade clustering, management and security
for Node.js and Java
• Lifecycle and governance for APIs, Products and Plans
• Access control over API’s, API Plans and API Products
• Advanced API usage analytics
• Customizable, self service developer portal for publishing APIs
• Policy enforcement, security and control
Create Run
ManageSecure
IBM API Connect: Simplified & Comprehensive
API foundation

z/OS Connect EE
Consumer
(Systems of Engagement)
External App
Developer
Internal App
Developer
Partner App
Developer
Business
Partner Apps
Mobile &
Web Apps
Enterprise
Internal Apps
Internet of
Things
Secure
API Policy Enforcement
Enterprise Security
Traffic control & mediation
Workload optimization
Monitoring/Analytics Collection
Manage
API Discovery
API, Plan, Product, Policy Creation
API, Plan, Product Version & Lifecycle
Management
Self-service App Developer Portal
API Monitoring & Analytics
Subscription & Community Management
Create & Run
(Node / Java)
Develop & Compose
Microservices
Connect Microservices to data
sources
Build, deploy, scale
Microservices
Monitor & debug Microservices
Unified Node & Java Runtime
Mgmt
z System / Legacy Apps
Cloud Service
Application Server
ESB / Middleware
Data Store
Provider
(Systems of Record)
API Gateway
APICmanagedMicroservicesTraffic
API Traffic
Deployment Options:
Bluemix Public,
Bluemix Dedicated
On Premise or
Customer Cloud
Where does API Connect fit?

z/OS Connect EEConnect Mobile and Cloud applications to
Systems of Record through APIs
Challenge:
• Varying data source access methods
• Special skills needed
• Multiple back end data authorization methods
• No z Systems services awareness
Solution:
• Leverage z/OS Connect running in Liberty Profile for z/OS to
infuse REST and JSON into their mainframe environment
Benefit:
• Rapidly develop reusable services
• Easily deploy APIs into a common enterprise catalog
• High throughput performance gains and shorter path to
data
• Easily plug into APIM strategy
• Efficiently leverage a common skill set

z/OS Connect EE
Support Apple Pay: Nationwide (PoC)
Requirements:
Customer Service and Billing needs a solution to offer Nationwide customers Apple Pay capabilities
Solution must be:
• Simple
• Reusable
• Support heterogeneous end-points
• Adherent to NW standards
• Quick delivery (Speed to market)
• Affordable
z/OS connect adoption and benefits
Improved access to zSystems assets for business functions, such as billing
Speed to market - API in one week
Reuse existing assets

z/OS Connect EE
zAPIs: The Big Picture
Cloud APIs
Mobile
Applications
Cloud-based
Services
DMZ
Access to systems of
records and enterprise
data via APIs
Enterprise
APIs
IoT APIs
(MQTT)
Create Run
ManageSecure
Analytics run on SoR system for
optimal performance
and security
CICS
IMS
WebSphere
DB2
Analytics
z/OS
Connect EE
Discovery
Invocation

Reference Papers
 IBM z Systems: The heart of the mobile and API economy
– http://www.redbooks.ibm.com/Redbooks.nsf/RedbookAbstracts/redp5310.html?Open
 Building an API bridge to your z Systems applications & data
– http://www.redbooks.ibm.com/Redbooks.nsf/RedbookAbstracts/redp5296.html?Open
 IBM z Systems integration guide for the Mobile and API economy
– http://www.redbooks.ibm.com/Redbooks.nsf/RedpieceAbstracts/redp5319.html?Open

z/OS Connect EE
Resources
51
Downloads
Explore the docs
Where to get help
z/OS Connect EE open beta runtime
z/OS Connect EE workstation tooling
z/OS Connect EE Knowledge Center
z/OS Connect EE Developer Center
dW Answers
z/OS Connect EE open beta forum
ibm.biz/zosconnect-open-beta
ibm.biz/zosconnect-tooling-download
ibm.biz/zosconnect-kc
ibm.biz/zosconnectdc
ibm.biz/zosconnect-dw-answers
ibm.biz/zcee-beta-forum

z/OS Connect EE
Try the latest z/OS Connect EE capabilities today
at zero cost, and with no installation required.
52
IBM z Systems Trial Program
Find out more, and sign up now at ibm.biz/ibmztrial

Trademarks
53
Notes:
Performance is in Internal Throughput Rate (ITR) ratio based on measurements and projections using standard IBM benchmarks in a controlled environment. The actual throughput that any user will experience will vary depending upon considerations
such as the amount of multiprogramming in the user's job stream, the I/O configuration, the storage configuration, and the workload processed. Therefore, no assurance can be given that an individual user will achieve throughput improvements
equivalent to the performance ratios stated here.
IBM hardware products are manufactured from new parts, or new and serviceable used parts. Regardless, our warranty terms apply.
All customer examples cited or described in this presentation are presented as illustrations of the manner in which some customers have used IBM products and the results they may have achieved. Actual environmental costs and performance
characteristics will vary depending on individual customer configurations and conditions.
This publication was produced in the United States. IBM may not offer the products, services or features discussed in this document in other countries, and the information may be subject to change without notice. Consult your local IBM business
contact for information on the product or services available in your area.
All statements regarding IBM's future direction and intent are subject to change or withdrawal without notice, and represent goals and objectives only.
Information about non-IBM products is obtained from the manufacturers of those products or their published announcements. IBM has not tested those products and cannot confirm the performance, compatibility, or any other claims related to non-IBM
products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
Prices subject to change without notice. Contact your IBM representative or Business Partner for the most current pricing in your geography.
This information provides only general descriptions of the types and portions of workloads that are eligible for execution on Specialty Engines (e.g, zIIPs, zAAPs, and IFLs) ("SEs"). IBM authorizes customers to use IBM SE only to execute the
processing of Eligible Workloads of specific Programs expressly authorized by IBM as specified in the “Authorized Use Table for IBM Machines” provided at www.ibm.com/systems/support/machine_warranties/machine_code/aut.html (“AUT”). No
other workload processing is authorized for execution on an SE. IBM offers SE at a lower price than General Processors/Central Processors because customers are authorized to use SEs only to process certain types and/or amounts of workloads as
specified by IBM in the AUT.
* Registered trademarks of IBM Corporation
The following are trademarks of the International Business Machines Corporation in the United States and/or other countries.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.
IT Infrastructure Library is a Registered Trade Mark of AXELOS Limited.
ITIL is a Registered Trade Mark of AXELOS Limited.
Linear Tape-Open, LTO, the LTO Logo, Ultrium, and the Ultrium logo are trademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its
subsidiaries in the United States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.
Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in the United States, other countries, or both and is used under license therefrom.
UNIX is a registered trademark of The Open Group in the United States and other countries.
VMware, the VMware logo, VMware Cloud Foundation, VMware Cloud Foundation Service, VMware vCenter Server, and VMware vSphere are registered trademarks or trademarks of VMware, Inc. or its
subsidiaries in the United States and/or other jurisdictions.
Other product and service names might be trademarks of IBM or other companies.

API for IBM Z Assets

Recomendados

Recomendados

Más contenido relacionado

La actualidad más candente

La actualidad más candente (16)

Similar a API for IBM Z Assets

Similar a API for IBM Z Assets (20)

Más de DevOps for Enterprise Systems

Más de DevOps for Enterprise Systems (20)

Último

Último (20)

API for IBM Z Assets