swellstores/swell-php

Swell API library for PHP

Swell is a customizable, API-first platform for powering modern B2C/B2B shopping experiences and marketplaces. Build and connect anything using your favorite technologies, and provide admins with an easy to use dashboard.

Example

require_once("/path/to/swell-php/lib/Swell.php");

$swell = new Swell\Client('my-store', 'secret-key');

$products = $swell->get('/products', [
  'category' => 't-shirts'
]);

print_r($products);

or with Composer

composer.json

"require": {
  "swellstores/swell-php": "dev-master"
},
"repositories": [
	{
		"type": "vcs",
		"url": "git@github.com:swellstores/swell-php.git"
	}
]

Then run composer update to download and install the library

require __DIR__ . '/vendor/autoload.php';

$swell = new Swell\Client('my-store', 'secret-key');

$products = $swell->get('/products', [
  'category' => 't-shirts'
]);

print_r($products);

Caching

This library provides in-memory caching enabled by default, using a version protocol that means you don't have to worry about stale cache. Records that don't change too frequently, such as products, will always return from cache when possible.

To disable caching behavior, use the option cache: false.

$swell = new Swell\Client('my-store', 'secret-key', [
	'cache' => false
]);

Documentation

API reference: https://developers.swell.is/backend-api/

Universal JavaScript client for Swell's Frontend API (Swell.js): https://github.com/swellstores/swell-js

Contributing

Pull requests are welcome

License

MIT

swellstores / swell-php