celitech-sdk / sdk
Requires
- php: ^8.0
- guzzlehttp/guzzle: ^7.0
- phpdocumentor/reflection-docblock: ^5.4
- symfony/property-access: ^7.0
- symfony/property-info: ^7.0
- symfony/serializer: ^7.0
Requires (Dev)
- laravel/pint: ^1.13.7
- nyholm/psr7: ^1.8
- php-http/mock-client: ^1.6
- phpstan/phpstan: ^1.8
- phpunit/phpunit: ^9
This package is auto-updated.
Last update: 2025-03-21 11:04:19 UTC
README
Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
Versions
- API version:
1.1.0 - SDK version:
1.3.38
About the API
Welcome to the CELITECH API documentation!
Useful links: Homepage | Support email | Blog
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: PHP >= 8.0
Installation
To get started with the SDK, we recommend installing using composer:
composer require celitech-sdk/sdk
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
These are the environment variables for the SDK:
| Name | Description |
|---|---|
| CLIENT_ID | Client ID parameter |
| CLIENT_SECRET | Client Secret parameter |
Environment 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
You can set a custom timeout for the SDK's HTTP requests as follows:
$sdk = new Client(timeout: 1000);
Sample Usage
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
<?php use Celitech\Client; $sdk = new Client(clientId: 'CLIENT_ID', clientSecret: 'CLIENT_SECRET'); $response = $sdk->destinations->listDestinations(); print_r($response);
Services
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
| Name |
|---|
| OAuth |
| Destinations |
| Packages |
| Purchases |
| ESim |
| IFrame |
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.