Quick Start

Set up your environment and use the REST API to communicate with the Oracle GoldenGate by performing the following tasks.

Prerequisites

Prerequisite	More Information
Obtain an Oracle GoldenGate user account.	https://docs.oracle.com/en/middleware/goldengate/core/23/coredoc/
Ensure that Oracle GoldenGate 23ai Microservices Architecture is installed.	Performing an Interactive Installation with OUI for MA
Ensure that you have a running Oracle GoldenGate Deployment.	Add a Deployment

Step 1: Obtain Account Information

From your account administrator, obtain the appropriate account credentials to enable you to access Oracle GoldenGate. Specifically, you will need:

User name and password for Oracle GoldenGate account.
The URL of your Oracle GoldenGate instance.

Step 2: Install cURL

The examples within this document use the cURL command-line tool to demonstrate how to access the Oracle GoldenGate REST API.

To connect securely to the server, you must install a version of cURL that supports SSL and provide an SSL certificate authority (CA) certificate file or bundle to authenticate against the Verisign CA certificate. For more information about:

Using cURL, see Use cURLs.
Authentication, see Authentication.

The following procedure demonstrates how to install cURL on a Windows 64–bit system.

In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the left navigation menu.
On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system, click the link to download the ZIP file, and install the software.
Navigate to the cURL CA Certs page at http://curl.haxx.se/docs/caextract.html and download the cacert.pem SSL CA certificate bundle in the folder where you installed cURL.
Open a command window, navigate to the directory where you installed cURL, and set the cURL environment variable, CURL_CA_BUNDLE, to the location of an SSL certificate authority (CA) certificate bundle. For example:

C:\curl> set CURL_CA_BUNDLE=cacert.pem

You are now ready to send requests to the Oracle GoldenGate using cURL.

Step 3: Create Your First Instance

After you have created a request document that defines the details of your service instance, you are ready to create your first Oracle GoldenGate instance.

Create your User Credentials
Extract
Replicat

Step 4: Review the Details of Your First Instance

Ensure that your first instance is running as configured and adjust if necessary.