Download the PHP package officeintegrator/zoi-php-sdk without Composer

PHP SDK

Table Of Contents

• Getting Started
• Registering a Zoho Office Integrator APIKey
• Environmental Setup
• Including the SDK in your project
• Configuration
• Initialization
• Sample Code
• License

Getting Started

Zoho Office Integrator PHP SDK used to help you quickly integrator Zoho Office Integrator editors in side your web application.

Registering a Zoho Office Integrator APIKey

Since Zoho Office Integrator APIs are authenticated with apikey, you should register your with Zoho to get an apikey. To register your app:

• Visit this page https://officeintegrator.zoho.com/. ( Sign-up for a Zoho Account if you don't have one)

• Enter your company name and short description about how you are going to using zoho office integrator in your application. Choose the type of your application(commerial or non-commercial) and generate the apikey.

• After filling above details, create an account in Zoho Office Integrator service and copy the apikey from the dashboard.

Environmental Setup

PHP SDK is installable through composer. composer is a tool for dependency management in PHP. Composer installs PHP sdk in your application from packagist.

• Client app must have PHP(version 7.0 and above)

• composer must be installed in your machine

Including the SDK in your project

You can include the SDK to your project using:

• Install composer from getcomposer.org (if not installed).

• Install PHP SDK

  • Navigate to the workspace of your client app.
  • Create a composer.json in your application add zoi-nodejs-sdk in dependency list. Example
  • Now run the command below:
• The PHP SDK will be installed and a package named /zoi-php-sdk-1.. will be created in your work space under the vendor folder.

Configuration

Before you get started with creating your PHP application, you need to register with Zoho Office Integrator to get an apikey for authentication.

• Configure API environment which decides the domain and the URL to make API calls.

• Use below script to configure your apikey that you get from Zoho Office Integrator dashboard.

• Create an instance of Logger Class to log exception and API information. By default, the SDK constructs a Logger instance with level - INFO and file_path - (sdk_logs.log parallel to node_modules)

Initializing the Application

Initialize the SDK using the following code.

• You can now access the functionalities of the SDK. Refer to the sample codes to make various API calls through the SDK.

SDK Sample code

• Make sure you have initialized the sdk before running below sample code snippet.
• Refer this repository for example codes to all Office Integrator API endpoints.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE.txt for more information.