PHPackages                             celitech-sdk/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. celitech-sdk/sdk

ActiveLibrary

celitech-sdk/sdk
================

1.3.63(1mo ago)064[57 PRs](https://github.com/Celitech/CelitechSDKPHP/pulls)MITPHPPHP ^8.0

Since Dec 6Pushed 1mo agoCompare

[ Source](https://github.com/Celitech/CelitechSDKPHP)[ Packagist](https://packagist.org/packages/celitech-sdk/sdk)[ RSS](/packages/celitech-sdk-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (10)Versions (74)Used By (0)

Celitech PHP SDK 1.3.63
=======================

[](#celitech-php-sdk-1363)

Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.

[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)

Versions
--------

[](#versions)

- API version: `1.3.63`
- SDK version: `1.3.63`

About the API
-------------

[](#about-the-api)

Welcome to the CELITECH API documentation!

Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/)

Table of Contents
-----------------

[](#table-of-contents)

- [Setup & Configuration](#setup--configuration)
    - [Supported Language Versions](#supported-language-versions)
    - [Installation](#installation)
- [Authentication](#authentication)
    - [OAuth Authentication](#oauth-authentication)
    - [Environment Variables](#environment-variables)
- [Setting a Custom Timeout](#setting-a-custom-timeout)
- [Sample Usage](#sample-usage)
- [Services](#services)
- [Models](#models)
- [License](#license)

Setup & Configuration
=========================

[](#setup--configuration)

Supported Language Versions
---------------------------

[](#supported-language-versions)

This SDK is compatible with the following versions: `PHP >= 8.0`

Installation
------------

[](#installation)

To get started with the SDK, we recommend installing using `composer`:

```
composer require celitech-sdk/sdk
```

Authentication
--------------

[](#authentication)

### OAuth Authentication

[](#oauth-authentication)

The Celitech API uses OAuth for authentication.

You need to provide the OAuth parameters when initializing the SDK.

```
new Client(
	clientId: 'CLIENT_ID',
	clientSecret: 'CLIENT_SECRET'
)
```

If you need to set or update the OAuth parameters after the SDK initialization, you can use:

```
sdk.setClientId('CLIENT_ID')
sdk.setClientSecret('CLIENT_SECRET')
```

Environment Variables
---------------------

[](#environment-variables)

These are the environment variables for the SDK:

NameDescriptionCLIENT\_IDClient ID parameterCLIENT\_SECRETClient Secret parameterEnvironment variables are a way to configure your application outside the code. You can set these environment variables on the command line or use your project's existing tooling for managing environment variables.

If you are using a `.env` file, a template with the variable names is provided in the `.env.example` file located in the same directory as this README.

Setting a Custom Timeout
------------------------

[](#setting-a-custom-timeout)

You can set a custom timeout for the SDK's HTTP requests as follows:

```
$sdk = new Client(timeout: 1000);
```

Sample Usage
============

[](#sample-usage)

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

```