¶ ByDesign API
¶ Introduction
ByDesign Provides a number of APIs available for use by our clients. While we still retain support for the majority of our older SOAP based WebService APIs, much of the functionality is being gradually moved into the RESTful WebAPI and WebHooks.
bydesign_api_documentation_(kb).zip
¶ Concepts and Data Logic
- Online Orders
- Online Sign-up (Rep Enrollment)
- Single Sign On
¶ RESTful WebAPI
The RESTful WebAPI is the latest API functionality available to our clients and encompasses a wide range of features for a variety of needs. These functions support either SimpleAuth or OAUTH depending on their intended usage with more session persistance support than was previously supported in the older SOAP WebService.
¶ WebHooks
WebHooks provide a mechanism to alert a 3rd-party system of specific events or data changes made within Freedom. When a triggering event occurs, a predetermined JSON message is sent to the 3rd-party with the contextual event information.
¶ SOAP WebService
While we are not currently looking to further develop these older SOAP WebService functions, they are still considered a favored workhorse for a number of our existing clients. There are currently no plans to deprecate these functions from availability for active use as not all functionality has been moved to the newer RESTful platform.
¶ Replicated Sites
Replicated Sites allow Reps to use a custom URL to provide a link to customers to their personal website and purchase product in their Cart.
To setup with API, please see the article below.
To setup with the WordPress Plugin, please see the article below.