keyqcloud/kyte-api-php

SDK for communicating with a Kyte API endpoint.

v1.0.0 2024-04-09 20:10 UTC

Requires

• php: >=7.2
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• aws/aws-sdk-php: ^3.101

Requires (Dev)

• phpunit/phpunit: *

MIT

• Kenneth Hough

README

The Kyte API PHP Client is a comprehensive and easy-to-use PHP client for interacting with the Kyte API. It encapsulates all the necessary methods for making HTTP requests to the Kyte API, including authentication, session management, and standard CRUD operations.

Features

• Supports all basic CRUD operations (Create, Read, Update, Delete).
• Handles authentication using API keys.
• Manages session tokens transparently.
• Easy to integrate and use in any PHP-based application.

Requirements

• PHP 7.4 or higher
• cURL extension enabled

Installation

Currently, you need to manually include this client in your PHP project. Place the Client.php file in your project's appropriate directory and include it using PHP's require or autoload mechanism.

require_once 'path/to/Client.php';

Usage

Initialization

First, initialize the client with your Kyte API credentials and endpoint.

use Kyte\Api\Client;

$publicKey = 'your-public-key';
$privateKey = 'your-private-key';
$kyteAccount = 'your-kyte-account';
$kyteIdentifier = 'your-kyte-identifier';
$kyteEndpoint = 'your-kyte-endpoint';
$kyteAppId = 'your-kyte-app-id'; // Optional

$client = new Client($publicKey, $privateKey, $kyteAccount, $kyteIdentifier, $kyteEndpoint, $kyteAppId);

Making Requests

Create a Session

$sessionDetails = $client->createSession($username, $password);

POST Request

$response = $client->post('model', $data);

GET Request

$response = $client->get('model', 'field', 'value');

PUT Request

$response = $client->put('model', 'field', 'value', $data);

DELETE Request

$response = $client->delete('model', 'field', 'value');

Error Handling

The client throws exceptions when it encounters errors. Make sure to catch these exceptions to handle errors gracefully in your application.

try {
    $response = $client->get('model', 'field', 'value');
} catch (Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

Support

For support and feature requests, please send an email to [e-mail].

Contributing

We welcome contributions to this client. Please send your pull requests to the repository.

License

This client is licensed under the MIT License - see the LICENSE file for details.