Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deadmantfa/yii2-zoho-api-client
A Client for Zoho API's built for Yii2
https://github.com/deadmantfa/yii2-zoho-api-client
Last synced: 10 days ago
JSON representation
A Client for Zoho API's built for Yii2
- Host: GitHub
- URL: https://github.com/deadmantfa/yii2-zoho-api-client
- Owner: deadmantfa
- License: mit
- Created: 2020-08-31T20:45:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-12T16:49:41.000Z (about 4 years ago)
- Last Synced: 2024-10-11T19:35:50.087Z (2 months ago)
- Language: PHP
- Size: 538 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Yii2 Zoho REST API Client
====================
A Client for Zoho RESTful API's
[](https://yiiframework.com/)
[](https://yiiframework.com/)
[](https://GitHub.com/deadmantfa/yii2-zoho-api-client/graphs/commit-activity)
[](https://saythanks.io/to/wenceslausdsilva%40gmail.com)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist deadmantfa/yii2-zoho-api-client "^v1.0.x"
```
or add
```
"deadmantfa/yii2-zoho-api-client": "^v1.0.x"
```
to the require section of your `composer.json` file.
Configuration
-----
Once the extension is installed, add it to your configuration :
Please note the redirect url for OAUTH2 to work properly, please add it to your client on Zoho before continuing further.
Replace ```` with an actual domain or localhost
`/zoho/default/auth?authclient=zoho`
In your `params.php` or `params-local.php` define the following
```php
'zoho-api-client-id' => '',
'zoho-api-client-secret' => '',
'zoho-organization-id' => '',
'zoho-redirect-uri' => '/zoho/default/auth?authclient=zoho'
```
Add the following in one of these file
`app/common/config/main.php` or `app/backend/config/main.php`
```php
'modules' => [
'zoho' => [
'class' => \deadmantfa\yii2\zoho\Module::class,
],
],
'components' => [
'authClientCollection' => [
'class' => \yii\authclient\Collection::class,
'clients' => [
'zoho' => [
'class' => \deadmantfa\yii2\zoho\auth\ZohoAuthClient::class,
'clientId' => $params['zoho-api-client-id'],
'clientSecret' => $params['zoho-api-client-secret'],
'returnUrl' => $params['zoho-redirect-uri'],
],
],
],
'zoho'=> [
'class' => \deadmantfa\yii2\zoho\components\ZohoApiClient::class,
'apiBaseUrl'=>'https://inventory.zoho.com/api/v1/',
'organizationId'=>$params['zoho-organization-id']
]
];
```
For Migration add the following to
`app/console/config/main.php`
```php
use yii\console\controllers\MigrateController;
'controllerMap' => [
'migrate' => [
'class' => MigrateController::class,
'migrationPath' => [
'@app/migrations',
'@yii/rbac/migrations', // Just in case you forgot to run it on console (see next note)
],
'migrationNamespaces' => [
'deadmantfa\yii2\zoho\migrations',
],
],
],
```
Then run the following command
```shell script
./yii migrate
```
Usage
-----
To use the zoho api we need to first authorize and generate access_token and refresh_token
(http:///zoho)
Follow the screenshots below
After generating the access token and refresh token you can now call any api which is provided by Zoho
```php
Yii::$app->zoho->get('items', []);
Yii::$app->zoho->post('items', []);
Yii::$app->zoho->put('items', []);
Yii::$app->zoho->delete('items', []);
```
[Zoho Rest API Documentation](https://www.zoho.com/developer/rest-api.html)
Dependencies
------------
* [Yii2 Framework](https://www.yiiframework.com/)
* [Yii2 Auth Client](https://github.com/yiisoft/yii2-authclient)
* [Yii2 Http CLient](https://github.com/yiisoft/yii2-httpclient)