Writing & Hosting Client Code

Now that you know About Client Extensibility of Directscale products let's cover how these customizations are coded and configured with the Directscale Platform. Directscale products are customized to a client's needs by hosting custom code in a web application(s) and integrating them with the Directscale Platform.

👍

Writing Custom Content For Back Office using the Content Management System?

Skip to Getting Started with Custom Content

Hosting Client Code


Choosing A Development Platform

Client customizations must be built and hosted in a web application. Clients can build web application(s) in any language by using the Directscale Extension API. Learn more about this by reading About The Extension API

👍

Directscale recommends building web application(s) using their C# Client Library available on NuGet.org. This makes hosting custom code and interacting with the Extension API simple. Learn more about building C# web applications by reading Microsofts Tutorial: Get started with C# and ASP.NET Core in Visual Studio

Choosing A Hosting Provider

Clients can host their web application(s) with their preferred vendor. Directscale offers a solution to host one web application on a client's behalf if it is built with the Directscale C# Client Library. See more about this solution by reading What is the Client Extension

👍

It is recommended that client's host their web application(s) with Azure in their West US Datacenter for the best performance. See Azure's quickstart guide to Create a Web App with C#, Java, PHP and more

❗️

A note about the Client Extension

If a client is using the Client Extension then they cannot create any other web applications to customize Directscale products. This is because the configurations of Process Hooks, Merchants, External Pages, and Webhooks are updated each time the Client Extension is deployed. See more about this by reading Deploying the Extension

📘

For Self-Hosted Web Applications accessing the Corporate Admin Database

The Corporate Admin Database is secured behind a firewall. In order for the external system to have access to the database, the IP address of the external system will need to be added to the allow list.
Please contact Directscale support to request a firewall rule to be added for your Web Servers.

Include the following information in the request

  • IP Address(es) with an explanation of what each address is.
  • Environment(s) that the server needs access to

Coding Tutorials


Ready to get started? Learn how to create endpoints that customize Directscale products


👍

Want to see a full working example?

All the source code for the coding tutorials can be downloaded as a C# ASP.NET Core web application project from the ACME Client Extension project on GitHub.org


Configuring Client Endpoints With Directscale


Once an endpoint is created in a Client Web Application, as outlined in the Coding Tutorials, it should be configured to be used by the Directscale system.

👍

Using the C# Client Library?

Learn how the library helps configure client endpoints by Configuring the Directscale Middleware and using the C# Middleware APIs to Auto-Configure during deployments

Learn how to configure client endpoints in Corporate Admin with the links below.


Did this page help you?