Qodex.ai

Download an Integration Binary

Number of APIs: 4

Integration kits include .jar files, configuration files, templates, documentation, and other content packaged with an integration. In this use case, you will search your environment for a specific integration. Once found, you will download the integration kit as a zip file.

The purpose of this use case is to provide a simplified view of the interaction with the PingOne Integration Catalog service. In a real world environment, an administrator would expand upon this example to ensure specific integrations were available. For instance, a PingCloud administrator could establish a connection to the PingOne Integration Catalog to retrieve integration kits and include them in the automated startup of containers.

This scenario illustrates the following common operations: * Get the environment ID. * Get a list of integrations and their versions. * Download the integration binary.

Prerequisites

Get an access token from the worker application that you created in Getting Started with the PingOne APIs. To get a token from a different worker application in an alternate sandbox environment, run the token request endpoint using the client ID and client secret of your chosen worker app to authenticate the request. For more information, see GET a Worker Application Access Token.

Workflow order of operations

To download a specific integration binary, you will need to complete the following tasks: 1. Make a GET request to the /environments endpoint to get the environment resource ID.

  1. Make a GET request to /environments/{{envID}}/integrations to retrieve a list of available integrations, using the filter parameter to provide a targeted result set.

  2. Make a GET request to {{apiPath}}/environments/{{envID}}/integrations/{{integrationID}}/versions to retrieve a list of available integration versions.

  3. Make a GET request to /environments/{{envID}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset

  1. Step 4: Download the integration zip file GET {{apiPath}}/environments/{{envID}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset

  2. Step 2: Get a list of integrations GET {{apiPath}}/environments/{{envID}}/integrations?expand=latestVersion&filter=(name co "PingID")

  3. Step 1: Get the environment ID GET {{apiPath}}/environments?limit=1

  4. Step 3: Get a list of integration versions GET {{apiPath}}/environments/{{envID}}/integrations/{{integrationID}}/versions