README.md

ArrowSphere public-api-client package

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

• Who Am I
• Check Domain

Catalog clients

• Classification
• Program
• Service (deprecated in favor of Family)
• Offer
• Add-on
• Family

Customers clients

• Customers

Consumption clients

• HealthCheck
• Monthly analytics

Licenses clients

• Licenses

Campaigns clients

• Campaigns