README

To create a connection, the current method is by creating a define() in your application which contains your API key.

This connection method will be updated as the framework matures, but for now it requires a define(). It's worth noting that setting $env to 'dev' when creating the connection will set the connection to developer mode. In order to accommodate developer mode, you need to have a developer constant labelled DIRECTSCALE_DEVAPIKEY. You can also set the key manually in any version of the Model.

Also a note, the Nubersoft Framework is required for this framework.

Here is an example of fetching user data:

# Create define
define('DIRECTSCALE_APIKEY', 'your123prod456key543here210');
# Create instance
$DirectScale = new \DirectScale\User(54321);
# Get distributor details
print_r($DirectScale->getDistInfo());

Example of common data functions:

use \DirectScale\ {
	User,
	User\Subscription,
	Orders,
	Products,
	Stores
};

try {
	$User = new User('15F92');
	$Subscription =	new Subscription($User);
	$Orders = new Orders($User);
	$Products = new Products();
	$Stores = new Stores($Products);

	print_r([
		# Notice here that the autoship is appended to the user data
		# when creating instance of Subscription
		$User->getData(),
		# This will just fetch the autoship by itself
		$Subscription->getOrder(),
		# Fetches a list of all products
		$Products->get(),
		# Fetches a specific sku
		$Products->getBySku('EXAMPLESKU123'),
		# Fetches the store regions
		$Stores->getRegions(),
		# Fetches the store cateories
		$Stores->getCategories()
	]);
}
catch(\DirectScale\Exception $e) {
	# It is worth noting that getting a single product by sku requires the "optional" params
	# or it will return an error from DirectScale
	echo $e->getErrorTransactionId();
}

Setting Developer Mode

Before instanciating, use the static method with dev as the parameter:

use \DirectScale\ {
    Model as Connection,
    User
};
# You will need a "dev" version of the API key
define('DIRECTSCALE_DEVAPIKEY', 'your123dev456key654here321');
# You can also save your regular key
define('DIRECTSCALE_APIKEY', 'your123prod456key543here210');
# Set the dev mode here
Connection::setMode('dev'); # <--- Comment out this line to make live
# Alternately, you can set the API key using the Model
# If using this method to set the API key, uncomment this line below, comment out the defines
# Connection::setApiKey('your123dev456key654here321');
# Start a user class
$User = new User(12345);
# Fetch the data
$info = $User->getDistInfo();
# Write out the api url
echo $User->getConnection()->getUrl();

This should produce the dev url:

https://dsapi-dev.directscale.com/v1/customers/?backofficeid=12345