SalesKing PHP SDK
Automate your workflow's by integrating and connecting your business with SalesKing. This PHP Software-Development-Kit provides solid and handy tools for building SalesKing App's
Run doc/examples/* AFTER registering an app on our free developer machine at:
To run them in your checkout directory, use the shiny new PHP build-in webserver.
cd salesking_php_sdk/docs/examples php -S localhost:8000
Feel free to help us improve the demo code.
Those examples use http basic auth. Please add your login credentials to the config array.
Create a new client in SalesKing:
$config = array( "sk_url" => "https://MY-SUBDOMAIN.salesking.eu", "user" => "firstname.lastname@example.org", "password" => 'yourPass' ); $sdk = new Salesking($config); $client = $sdk->getObject("client"); $client->organisation = "salesking"; $response = $client->save();
Get a list of clients
$sdk = new Salesking($config); $clients = $sdk->getCollection(array("type" => "client","autoload" => true)); $clients->sort("ASC")->sortby("number")->q("salesking")->load();
The SalesKing URL MUST not have a trailing slash / as we append /api/endpoint to it e.g https://MY-SUBDOMAIN.salesking.eu/api/contacts
More examples e.g. on how to create documents e.g.
Login / Authentication
The SDK supports login by HTTP Basic Auth(user email+password) or oAuth2.
HTTP Basic Auth
Basic Auth is the quickest way to get started, but it's a security risks! If someone grabs your login he can do whatever you can! PLEASE use a separate API User and, in production environments, reduce his rights with SalesKing's Role-System. Also note that a user session expires if he logs-in twice (Web+Api or two browsers)
It's ok to use this method in private one-to-one integrations, where you are the only user talking to your own SalesKing account.
oAuth should be used for web-services allowing users to connect a SalesKing account and if you aim for higher security. With oAuth it's the app that talks to a user account with reduced rights. Users have to interact by granting an app access and can revoke apps any time, just like Facebook or Twitter apps.
Developers need to register an app to get oauth credentials(key+secret). Apps are initally only visible to the creator and if you know the app url. If you have a great app please contact the SalesKing team to relase it for all users.
Run all tests with PHPUnit:
No PHP Unit? See install Guide for Ubuntu
Run a single testfile
phpunit --colors tests/SaleskingCollectionTest.php
Run a group(or single method) of tests (see @group markup in each test-function comments)
phpunit --colors --group live-invoice tests
Test against a real SalesKing account.
Copy and edit tests/test_config.php.default Those live tests are skipped if no tests/test_config.php file is found or if the login data is invalid.
Copyright (c) 2012 David Jardin, released under the MIT license