simpro/restclient-php

This package is abandoned and no longer maintained. No replacement package was suggested.

Authenticate and access the simPRO RESTful API using PHP

1.0 2018-09-12 00:02 UTC

Requires

• php: >=5.3.0
• league/oauth2-client: ^2.3
• pimple/pimple: ^3.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.12

MIT

README

This library gives you a starting point for working with the simPRO RESTful API using PHP. It provides a means of authenticating, sending requests and receiving responses.

This readme assumes that you have read through each step of the Getting Started section of our API documentation. Instructions for how to use each of the grant types are detailed below.

How to install

composer require simpro/restclient-php

Client Credentials Grant

If your application authenticates using a client credentials grant, then see our client credentials example.

Resource Owner Credentials Grant

If your application authenticates using a resource owner credentials grant, then see our resource owner example.

Authorisation Code Grant

If your application authenticates using an authorisation code grant, then see our authorisation code example.

API Key

If your application authenticates using an API Key, then see our API key example.

Implicit Code Grant

If your application authenticates using an implicit code grant, then you cannot perform this using PHP. Implicit grants are specifically designed for javascript clients. However, the workflow is similar to authorisation code grant. Please see our documentation for instructions.

Workflow example

Once you have your provider loaded, find an example of creating, reading, updating and deleting data here.

Still have questions?

Feel free to ask us a question on our support forum if you are unable to get your application up and running using our API.