ChannelEngine: REST API client for channels

About this article

This article lists the ChannelEngine's API client libraries for channels.

Table of contents

Introduction

API clients for channels

Generate an API client library

• Prerequisites
• Procedure
• Configuration files

Introduction

You can generate language-specific API client libraries to create custom connections with ChannelEngine's Channel API. These libraries are packages that allow for easier interaction with the APIs and a streamlined way to access their latest features and functionality.

API clients for channels

Generate an API client library

You can generate an API client library from ChannelEngine's OpenAPI specification via the OpenAPI generator and the command-line interface. As a result, you get access to ChannelEngine's language-specific API client libraries, server stubs, documentation, and configuration.

Prerequisites

Before you start, make sure to meet the following prerequisites:

• Install Java on your local machine.
• Install Powershell on your local machine if you use macOS or Linux.
• Install OpenAPI Generator's CLI on your local machine. To do so, use either:
  • The npm package wrappernpm install @openapitools/openapi-generator-cli
  • The yarn package manageryarn add @openapitools/openapi-generator-cli

Procedure

1. Open PowerShell. To configure the security settings and set the security protocol, run the command:

   [Net.ServicePointManager]::SecurityProtocol = "tls12, tls11, tls"

2. To configure the environment settings so that your application trusts remote URLs when parsing OpenAPI documents, run the command: 

   [System.Environment]::SetEnvironmentVariable('JAVA_TOOL_OPTIONS','-Dio.swagger.parser.util.RemoteUrl.trustAll=true -Dio.swagger.v3.parser.util.RemoteUrl.trustAll=true') 

3. To generate the API library, run the OpenAPI generator CLI command:

   openapi-generator-cli generate -g {language} -i {swagger_file_url} -o {destination_folder}--config {configuration_file}--additional-properties{additional_properties}

   In the command above, provide your information for the following: 
   • {language} - the programming language of your application. E.g.: Java, Ruby.
   • {swagger_file_url} - the URL to the OpenAPI specification file (i.e.: Channel API).
   • {destination_folder} - the path to where you want the generated code saved on your local machine.
   • {configuration_file} - the path to the configuration file, in the JSON or YAML format. The next section contains examples of configuration files per programming language. For more information on the configuration supported by the OpenAPI Generator, check out the article Configuration options on OpenAPI generator.
   • {additional_properties} - additional options in the form of comma-separated key-value pairs. E.g.: the version number for the generated package.

   Below you can see an example of the command that generates a Java client library for ChannelEngine's Channel API:

   openapi-generator-cli generate -g java -i https://demo.channelengine.net/api/swagger/merchant/swagger.json -o "C:\Projects\api-client-generation\clients\channel-api-client-java"--config "C:\Projects\api-client-generation\clients\channel-api-client-java\swagger-config.json"--additional-properties "packageVersion=3.0.0,gemVersion=3.0.0,podVersion=3.0.0,artifactVersion=3.0.0"

Configuration files