/public-api-client

The official PHP client for ArrowSphere's public API

Primary LanguagePHP

ArrowSphere public-api-client package

Latest Stable Version Minimum PHP Version Build Status

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

To use this package, you need valid access to ArrowSphere, 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