arrowsphere/public-api-client

The official PHP client for ArrowSphere's public API

0.11.12 2024-10-23 15:00 UTC

README

Latest Stable Version Minimum PHP Version Build Status

This package provides a PHP client for ArrowSphere Cloud's public API. It should be the only way to make calls to ArrowSphere Cloud's API with PHP code.

To use this package, you need valid access to ArrowSphere Cloud, with a valid API key.

Installation

Install the latest version with

$ composer require arrowsphere/public-api-client

Basic usage

<?php

use ArrowSphere\PublicApiClient\PublicApiClient;

const URL = 'https://your-url-to-arrowsphere.example.com';
const API_KEY = 'your API key in ArrowSphere';

$client = (new PublicApiClient())
    ->setUrl(URL)
    ->setApiKey(API_KEY)
    ->setDefaultHeaders([
        'myHeader' => 'myValue',
    ])
;

$whoami = $client->getWhoamiClient()->getWhoami();
echo "Hello " . $whoami->getCompanyName();

Specific API clients

General clients

Catalog clients

Customers clients

Consumption clients

Licenses clients

Campaigns clients

Cart clients

Notification clients

Support clients