ch-apimatic / ch-apimatic-sdk

0.0.1 2026-09-23 14:38 UTC

Requires

• php: ^7.2 || ^8.0
• ext-curl: *
• ext-json: *
• apimatic/core: ~0.3.17
• apimatic/core-interfaces: ~0.1.5
• apimatic/unirest-php: ^4.0.6

Requires (Dev)

• phan/phan: 5.4.5
• squizlabs/php_codesniffer: ^3.5

MIT

• Muhammad Rafay

Published on Packagist.org on 2026-09-23 14:39 UTC

README

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "ch-apimatic/ch-apimatic-sdk:0.0.1"

Or add it to the composer.json file manually as given below:

"require": {
    "ch-apimatic/ch-apimatic-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/ch-apimatic/ch-apimatic-sdk#0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
timeout	int	Timeout for API calls in seconds. Default: 30
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
loggingConfiguration	LoggingConfigurationBuilder	Represents the logging configurations for API calls
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
basicAuthCredentials	BasicAuthCredentials	The Credentials Setter for Basic Authentication

The API client can be initialized as follows:

use OpenApiSpecForClickHouseCloudLib\Logging\LoggingConfigurationBuilder;
use OpenApiSpecForClickHouseCloudLib\Logging\RequestLoggingConfigurationBuilder;
use OpenApiSpecForClickHouseCloudLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use OpenApiSpecForClickHouseCloudLib\Authentication\BasicAuthCredentialsBuilder;
use OpenApiSpecForClickHouseCloudLib\OpenApiSpecForClickHouseCloudClientBuilder;

$client = OpenApiSpecForClickHouseCloudClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'BasicAuthUserName',
            'BasicAuthPassword'
        )
    )
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

Authorization

This API uses the following authentication schemes.

• basicAuth (Basic Authentication)

List of APIs

• Usermanagement
• Role Management
• AP Ikeys
• Query AP Iendpoints
• Organization
• Billing
• Service
• Backup
• Snapshot
• Prometheus
• Click Pipes
• Click Stack
• Postgres
• UDF

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse