README

A PHP client library for myERP's API.

Installation Using Composer

Assuming composer.phar is located in your project's root directory, run the following command:

php composer.phar require myerp/myerp-php-api-client:~1.0.2

Getting Started

This wrapper uses Guzzle to communicate with the REST web service.

1 - Retrieve your API_KEY and your API_EMAIL from the API settings. More information here.
2 - Initiate the client by:

use MyERP\MyERP;
$myERP = new MyERP('API_EMAIL', 'API_KEY');

3 - Now you're ready to make authorized API requests to your domain!

// Get all the customers and leads
$customers = $myERP->customers()->findAll();
var_dump($customers);

// Get a specific customer/lead
$customer = $myERP->customers()->find(261367);
echo $customer['full_name'] . ' [id=#' . $customer['id'] . ']' . "\n";

// create a customer
$jane = [
    "type" => 2, //individual
    "status" => 1, //customer
    "first_name" => "Jane",
    "last_name" => "Doe",
    "email" => "jane.doe@mail.com"
];
$jane = $myERP->customers()->save($jane);
echo $jane['full_name'] . ' created [id=#' . $jane['id'] . ', email=' . $jane['email'] . ']' . "\n";

// update some fields
$jane['email'] = 'newemail@mail.com';
$jane = $myERP->customers()->save($jane);
echo $jane['full_name'] . ' updated [id=#' . $jane['id'] . ', email=' . $jane['email'] . ']' . "\n";

// delete a customer
$byeJane = $myERP->customers()->delete(261368);
echo $byeJane['full_name'] . ' deleted [id=#' . $byeJane['id'] . ', email=' . $byeJane['email'] . ']' . "\n";

// catching errors
try {
  $response = $myERP->customers()->find(2613670);
  //....
} catch(APIException $e) {
  echo $e->getCode() . ' ' . $e->getMessage();
}

Contributing

Thanks for considering contributing to this project.

Finding something to do

Ask, or pick an issue and comment on it announcing your desire to work on it. Ideally wait until we assign it to you to minimize work duplication.

Reporting an issue

Search existing issues before raising a new one.
Include as much detail as possible.

Pull requests

Make it clear in the issue tracker what you are working on, so that someone else doesn't duplicate the work.
Use a feature branch, not master.
Rebase your feature branch onto origin/master before raising the PR.
Keep up to date with changes in master so your PR is easy to merge.
Be descriptive in your PR message: what is it for, why is it needed, etc.
Make sure the tests pass
Squash related commits as much as possible.

Coding style

Try to match the existing indent style.
Don't abuse the pre-processor.
Don't mix platform-specific stuff into the main code.

License

The myERP API wrapper is released under the MIT License.

myerp / myerp-php-api-client

Maintainers

Details