README

A PHP client library for interacting with the Apache Superset API. This library provides an easy-to-use interface for authenticating, retrieving dashboards, and managing embedded content.

Installation

Install the library using Composer:

composer require mihaikelemen/apache-superset-php-client

Requirements

• PHP 8.4 or higher
• ext-curl
• ext-json
• GuzzleHTTP
• Symfony Serializer

Quick Start

<?php

require 'vendor/autoload.php';

use Superset\SupersetFactory;

// Create an authenticated client
$superset = SupersetFactory::createAuthenticated(
    baseUrl: 'https://your-superset-instance.com',
    username: 'your-username',
    password: 'your-password'
);

// Retrieve dashboards
$dashboards = $superset->dashboard()->list();

// Get a specific dashboard
$dashboard = $superset->dashboard()->get('my-dashboard-slug');

Documentation

For detailed usage instructions, authentication methods, and advanced configuration options, please refer to the USAGE.md.

Features

• Multiple authentication methods (username/password, bearer token)
• Dashboard operations (list, retrieve, embed)
• Guest token generation for embedded dashboards
• CSRF token management
• Direct API access for all HTTP methods
• Configurable HTTP client settings
• Logging support for debugging and monitoring

Contributing

Contributions are welcome! Please refer to the CONTRIBUTING.md file for guidelines.

License

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

Acknowledgments

• Uses GuzzleHTTP as the HTTP client
• Uses Symfony Serializer for data transformation
• Uses Monolog for logging