Commerce Connector Setup

TABLE OF CONTENTS


ERP Connector - Setup Guide

Introduction

This article provides setup instructions for configuring ERP connectors in the local development environment. It is intended exclusively for developers implementing or customizing ERP connector touchpoints using Znode 10.

Prerequisites

Before beginning the setup process, ensure the following:

  • Access to the Znode Admin Console
  • ERP connectors and touchpoints are configured in Znode
  • Access to the Custom API SDK (downloadable using Znode CLI)
  • Visual Studio is installed for local development

Visual Studio Installation

  • Visit: https://visualstudio.microsoft.com
  • Download and install the latest version of Visual Studio (Community, Professional, or Enterprise)
  • Install optional extensions to enhance code quality and readability

Configure ERP Connector in Znode Admin

  • Log in to the Znode Admin Console
  • Navigate to Dev Center > ERP Connectors
  • Create a new connector or use an existing one
  • Configure the connector’s touchpoints to enable or disable features as required

Setting Up the Custom API Locally

To begin development with ERP connectors:

  • Clone the znode10-customapi-sdkrepository
    • Use a client-specific SDK if provided
  • Open the solution in Visual Studio
    • Set Engine.Custom.Api as the startup project
  • Build and run the solution
    • The Custom API will be hosted at:
      https://localhost:7222
  • Modify the logic for the required ERP connector touchpoints

Deploy Custom Changes

After implementing custom logic, deploy changes using the Znode CLI:

Command:

ZnodeDeploy

Ensure the following endpoint configurations are in place for the Custom API microservice (configured by the DevOps team):

"CustomAPIRootUri": "https://<CustomAPIRouting_URL>",
"ZnodeApiRootUri": "https://<ZnodeAPIURL>",
"ZnodeApiV2RootUri": "https://<ZnodeAPIV2URL>"

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.