For AI agents: visit https://developers.directscale.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
DirectScale DevelopersDirectScale DevelopersPublic API GatewayAbstractions Reference
HomeGuidesRecipesAPI ReferenceChangelog
Public API GatewayAbstractions ReferenceHelp CenterAsk a DevLog InDirectScale Developers
Guides
Help CenterAsk a DevLog In
Video: Binary XML Helper

Getting Started

  • Welcome
  • About Client Extensibility

Client Web Applications

  • Writing & Hosting Client Code
  • Securing Client Web Applications
    • Configuring API Keys
    • Managing API Keys
  • Configuring An API Proxy
  • Debugging Client Web Applications
    • Set Up Your Local Environment
    • Exposing And Configuring A Server

Extension API

  • About The Extension API

C# Client Library

  • About the C# Client Library
  • How the C# Client Library Works
  • Getting Started with the Library
  • Calling the Extension API
    • Using Service APIs
    • Using Hook APIs
  • Authorizing Client Web Application APIs
  • Deploying with the C# Client Extension
  • Client Library Reference
  • C# Client Library Version History
  • Debugging A Client Web Application

Client Extension

  • What is the Client Extension
  • Getting started with the Client Extension
  • Deployment Pipeline
    • Building the Client Extension
    • Deploying A Build Version
  • Securing The Client Extension
  • Debugging The Client Extension

Events & Webhooks

  • About Events & Webhooks
  • How Events & Webhooks Work
  • Creating & Configuring Webhooks
  • Webhook Best Practices
  • Debugging Events & Webhooks
  • Securing Webhooks

External Pages

  • About External Pages
  • How External Pages Work
  • Creating & Configuring External Pages
  • Debugging External Pages
  • Securing External Pages

Merchants

  • About Merchants
  • How Merchants Work
  • Creating & Configuring Merchants
    • Custom Commission Merchant Example
    • Custom Money In Merchant Example
    • Custom E-Wallet Merchant Example
  • Debugging Merchants
  • Securing Merchants
  • Merchant ID Reference

Process Hooks

  • About Process Hooks
  • How Process Hooks Work
  • Creating & Configuring Process Hooks
  • Debugging Process Hooks
  • Securing Process Hooks
  • Persisting DirectScale Exceptions

API

  • Getting Started with the Public API
    • Public API Overview
    • Authorization
    • Authentication: Getting API Keys
    • Best Practices
    • Status and Error Codes
    • Making Your First Request
    • Testing Public API with Postman
  • Docs & Testing Gateway
  • Public API Guides
    • Updating Shipment Packages with APIs
    • Creating an Order with the Public API
    • Creating an Associate with the Public API

Cloudspark Custom Content

  • Getting Started with Custom Content
  • AngularJS with DirectScale
  • Razor Syntax Integration
  • JavaScript Insertions
    • Adding SKU Order Quantity Limits
    • Removing the You Live in California Checkbox from Market Selector
    • Requiring Kit Item Before Submitting Enrollment Application
    • Adding Facebook Pixel to Your eCommerce Shop
    • Inserting a Custom JavaScript File
    • Adding an Associate's Name to the Web Office Header
    • Adding Hotjar Analytic Tracking
  • Custom CSS
  • Custom Pages
  • Custom Admin Pages
  • Custom APIs
    • Custom API Proxy
    • Calling APIs in the Extension
  • eCommerce Shop Page Templates
    • Enabling a Page Template
  • eCommerce Shop Component Templates
    • Enabling a Component Template
  • Custom Widgets
    • One Section Widget
    • Two Section Widget
    • Three Section Widget
    • Card-Flip Functionality
    • Event Countdown Widget
    • Reward Points Balance Widget
    • Commission Balance Widget
    • Important KPI Widget
  • Web Office Pages Base Code
    • Base Code: Web Office Documents & Media Page
  • Login Popups
  • Custom Web Office Login Page Content
  • Guides
    • Publishing to Stage/Live Environments
    • Uploading Files and Assets
    • Managing and Localizing Text Elements
    • Inserting a Custom CSS Stylesheet
    • Adding an External Page to Admin Navigation
    • Customizing the Product Description and Specifications
    • Editing Metadata
    • Link to eCommerce Shop Pages
    • Calling APIs in Custom Content

Cloudspark Single Sign-On

  • Single Sign-On (SSO): Inbound/Outbound
  • External App to Web Office (Customer ID)
  • External App to Web Office (External ID)
  • Web Office to External App
  • Admin Site to External App
  • Custom Page/Widget to External App

Commissions Resources

  • Enabling XML
  • XML Editor
  • Using XML
  • Creating a Compensation Plan
    • Template Name
    • Volume Ranges (Data Range)
    • Volumes
    • Tree Volumes (Tree ACRs)
    • Client Default KPI: PVAccumulator and GroupVolumeTree
    • Rules
    • Payments
    • Cycle Pay
    • Rollover Rules
    • KPIs (Stats)
    • Adding Rank Values to the Database
    • Setting Stats and Projected Commissions Templates
  • Templates
    • Template: Weekly Binary Compensation Plan XML
    • Template: Monthly Unilevel Compensation Plan XML
  • XML Reference
    • Volume Range Types
    • Volume Accumulators
    • Volume Types
    • Tree Accumulators
    • Conditions
    • Payment Sources
    • Payment Filters
    • Payment Groups
    • Payment Pools
    • KPI Accumulators
    • OptionConditionEvaluator
    • Rollover Rules
    • PVOptionPay
    • BalancedLegRuleFixPay
  • Videos
    • Video: XML Commission Editor Overview
    • Video: KPIs (Stats) in an XML Commission Plan
    • Video: Volume Accumulator Types
    • Video: Volumes in an XML Commission Plan
    • Video: Corporate Admin Commissions Section Overview
    • Video: Commission Hooks
    • Video: Binary XML Helper
    • Video: Rules in an XML Commission Plan

Database

  • Database Overview
  • Data Editor
    • Enabling and Accessing
    • Visual Editor
    • SQL Editor
    • Exporting a Table
    • Custom Client Schema
  • Disabling Specific Corporate Admin Email Templates
  • SQL Server Firewall Rules
  • Creating Custom [Client] Tables

IfThengine V1

  • IfThengine V1
    • Database Schema
    • Domain-Specific Language (DSL)
    • Rules
  • Data Point Service
    • Data Points
    • Data Point Providers
    • Data Point Categories (GADP)
  • Outcomes
    • Creating Outcomes
    • Locking Outcomes
    • Passing Arguments to Outcomes

Custom Fields

  • Using Custom Fields
  • Guides
    • Using Custom Fields in Corporate Admin
    • Basing Rules Off Associate Custom Fields in Compensation Plans
    • Updating Associate Custom Fields with API
    • Solution: Pick a Pack

Resources

  • DirectScale Glossary
Powered by 

Video: Binary XML Helper

Updated about 1 year ago


Video: Commission Hooks
Video: Rules in an XML Commission Plan
Did this page help you?