Download the PHP package s-patompong/hmrc-api-php without Composer
On this page you can find all versions of the php package s-patompong/hmrc-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package hmrc-api-php
HMRC API PHP
This library can be used to connect and does operations on HMRC API https://developer.service.hmrc.gov.uk/api-documentation.
How to use
For global API such as Hello World, you can use HelloWorldRequest class to deal with the API call.
For application-restricted API call such as Hello Application. First set the server token using ServerToken class and then you can use HelloApplicationRequest class to call the API.
For user-restricted API call, please see the next section.
User-Restricted API call
The easiest way to learn about this is by running the local server using php -S localhost:8080 command at the root of this library. And then navigate to http://localhost:8080/examples/index.php on your browser. Don't forget to setup the credentials inside examples/config.php file.
You can gain the access token by create HMRC Oauth2 Provider and redirect to authorize URL (see example/oauth2/create-access-token.php for example).
After user grant authorize on HMRC authorization page, it will redirect back to $callbackUri, which in the example above, the callback.php file.
Content of callback.php
You need to use \HMRC\Oauth2\AccessToken class to get and set access token. The class that do the request will get Access Token from this class.
After get the access token and save it inside \HMRC\Oauth2\AccessToken, we can start calling user-restricted API. For example, here is the request to hello user endpoint.
Change between sandbox and live environment
In default mode, this library will talk with sandbox environment of HMRC. If you want to use live environment, you can call it via Environment singleton.
Development & Contribution
Contributor is more than welcome to help develop this library, all the important methods should have unit test.
To run test, simply call composer test command on terminal.
