Quick Start Scenarios

Follow the Quick Start Scenarios to quickly configure an end-to-end solution. There are quick start scenarios available for both API provider and API requester.

Click on the link to find the scenario you need:
API provider scenarios
API requester scenarios

API provider Quick Start Scenarios

Templates are provided with pre-configured IBM® z/OS® Connect configuration files and pre-generated artifacts for services and APIs. The scenarios also describe how these services and APIs are generated by the tools so you can re-create the services and APIs yourself.

Follow these scenarios to learn how to create and deploy services and APIs to access and act on resources on a z/OS subsystem through REST APIs.

Using the CICS® service provider to invoke the CICS catalog manager program.
In this scenario, you prepare the CICS catalog manager program, then create a IBM z/OS Connect server by using the supplied template. This template includes the services and API required to call the CICS catalog manager program. It also contains a pre-configured server.xml file, which requires minor customization for your environment (for example, the host and port values for your IPIC connection to the CICS region). The scenario starts by preparing the CICS catalog manager program.
Diagram shows how IBM z/OS Connect passes the request from the client to the CICS catalog manager application.
Using the IMS service provider to invoke the IMS phonebook transaction.
In this scenario, you prepare the IMS phonebook transaction first. You then create a IBM z/OS Connect server by using the supplied template. This template includes the services, API, connection, and interactions profiles and a pre-configured server.xml file, that are required to call the IMS phonebook transaction. Only minor customization for your environment is required (for example, the host and port values for your connection to the IMS system). The scenario starts by preparing the IMS phonebook transaction.
Diagram shows how IBM z/OS Connect passes the request from the client to the IMS phonebook transaction.
Using the IMS database service provider to query the IMS database.
In this scenario, you prepare the IMS database first. You then create a IBM z/OS Connect server by using the supplied template. This template includes the services, connection profiles, and a pre-configured server.xml file that are required to query the IMS database. Only minor customization for your environment is required (for example, the host and port values for your connection to the IMS database). The scenario starts by preparing the sample IMS database.
Diagram shows how IBM z/OS Connect passes the request from the client to the IMS database.
Using the IBM MQ service provider to invoke the stock query application.
In this scenario, you prepare the stock query application first. You then create a IBM z/OS Connect server, a two-way service, and an API to invoke the stock query application. The scenario starts by preparing the stock query application.
Diagram shows how IBM z/OS Connect passes the request from the client to the IBM MQ stock query application.
Call a Db2® native REST service.
In this scenario, Db2 native REST services are created based on the Db2 sample Employee table. You then create a IBM z/OS Connect server by using the supplied template. This template includes the services and API required to call the created Db2 native REST services. It also contains a pre-configured server.xml file, which requires minor customization for your environment. For example, the host and port values for your connection to the Db2 instance. This scenario starts by preparing Db2 to create native REST services.
Diagram shows how IBM z/OS Connect passes the request from the client to the Db2 database.
Configure HA for connections to IBM z/OS Connect.
This scenario shows you how to implement high availability for inbound requests to two IBM z/OS Connect servers that use port sharing and shared configuration data. The scenario guides you through setting up TCP/IP port sharing, creating a shared configuration file, setting up shared resources, the IBM z/OS Connect servers, and test your scenario works in a high availability fashion. The scenario starts with configuring HA connections to IBM z/OS Connect.
Diagram showing a Sysplex Distributor and Port Sharing being used to connect to a z Subsystems Address Space via multiple IBM z/OS Connect servers
Configure HA for connections to CICS.
This scenario shows you how to implement high availability for connections to two CICS regions. The scenario guides you in configuring your CICS regions and IBM z/OS Connect servers for IPIC HA, and tests your scenario is working in a high availability fashion. The scenario starts with configuring HA connections into CICS.
Graphical representation of two IBM z/OS Connect servers using port sharing and to distribute requests between two CICS systems

API requester Quick Start Scenarios

These scenarios provide step-by-step instructions for your CICS, IMS, or z/OS application to call RESTful APIs through z/OS Connect (OpenAPI 2).

These scenarios describe how to create your API requester by using the supplied tools and call a remote RESTful API endpoint.

Calling an API from a CICS transaction.
This scenario shows you how to make your CICS application call your IBM z/OS Connect server. The server then makes an API requester call to the RESTful API endpoint, which is simulated by a second IBM z/OS Connect server and a CICS region that hosts the catalog manager program. The scenario starts with preparing the RESTful API endpoint.
The request is passed from the CICS client application via the communication stub to IBM z/OS Connect which connects to the RESTful API in the API provider.
Calling an API from an IMS or z/OS application.
This scenario shows you how to make a call from an IMS or z/OS application to your IBM z/OS Connect server. Your server then makes an API requester call to the RESTful API endpoint, which is simulated by a second IBM z/OS Connect server and IMS region that hosts the phonebook application. The scenario starts with preparing the RESTful API endpoint.
The request is passed from the IMS client application via the communication stub to IBM z/OS ConnectE which connects to the RESTful API in the API provider.