README

What is it?

A lightweight HTTP REST client for Calix AXOS Northbound interface.

No worrying about HTTP and authentication. Just provide an endpoint path and the payload data.

Table of Contents

• What is it?
• Installation
• Requirements
• Instantiation
  • Using Environment variables
  • Using Constructor arguments
  • Options
• Response
• Request Methods
  • Parameters
  • Path replacement
  • GET Method
  • POST Method
  • PUT Method
  • DELETE Method
  • Request Method

Installation

composer require ocolin/calix-axos

Requirements

• php ^8.3
• guzzlehttp/guzzle ^7.10
• ocolin/global-type ^2.0

Instantiation

The client can be configured either via constructor arguments or environment parameters.

Using Environment variables

// Setting manually for demonstration
$_ENV['SMX_AXOS_HOST'] = 'https://smx.servername.com:18443/rest/v1/';
$_ENV['SMX_AXOS_USERNAME'] = 'api_user';
$_ENV['SMX_AXOS_PASSWORD'] = 'password1234';

$client = new Ocolin\CalixAxos\Client();

Using Constructor arguments

The constructor takes a DTO called Config.

$client = new Ocolin\CalixAxos\Client(
    client: new Ocolin\CalixAxos\Config(
            host: 'https://smx.servername.com:18443/rest/v1/',
        username: 'api_user',
        password: 'password1234'
    )
);

Options

The Config object can also take an options parameter for setting guzzle options such as HTTP timeout, verifying SSL, etc.

Default Options:

• timeout: 20 sec
• verify: false

$client = new Ocolin\CalixAxos\Client(
    client: new Ocolin\CalixAxos\Config(
        options: [
            'timeout' => 60,
            'verify'  => true  
        ]
    )
);

Response

The client will response with a data object containing the following properties:

Request Methods

The Calix API allows four HTTP methods, each is a function on the client:

Parameters

Path Replacement

Any parameters in the query argument with names that match a variable token in the endpoint path name will swap those token names with their value. This allows you to past the endpoint URI as is from the docs and replace them automatically. See the GET method example below.

GET Method

$response = $client->get(
    endpoint: '/config/device/{device-name}/ont',
       query: [ 
            'device-name' => 'OLT-NAME',
            'ont-id'      => 777
       ]
);

POST Method

$response = $client->post(
    endpoint: '/config/device/{device-name}/ont',
       query: [ 'device-name' => 'OLT-NAME' ],
        body: [
            'ont-id'         => 777,
            'ont-reg-id'     => 777,
            'ont-type'       => 'Residential',
            'ont-profile-id' => '844G'
        ]   
);

PUT Method

$response = $client->put(
    endpoint: '/config/device/{device-name}/ont',
       query: [ 'device-name' => 'OLT-NAME' ],
        body: [
            'ont-id'         => 777,
            'ont-reg-id'     => 777,
            'ont-type'       => 'Business',
            'ont-profile-id' => '844G'
        ]   
);

DELETE Method

$response = $client->delete(
    endpoint: '/config/device/{device-name}/ont',
       query: [ 
            'device-name' => 'OLT-NAME',
            'ont-id'      => 777
       ]
);

Request Method

There is a request method which lets you manually specify the HTTP method to use rather than a specific method function.

$response = $client->request(
    endpoint: '/config/device/{device-name}/ont',
      method: 'POST',
       query: [ 'device-name' => 'OLT-NAME' ],
        body: [
            'ont-id'         => 777,
            'ont-reg-id'     => 777,
            'ont-type'       => 'Business',
            'ont-profile-id' => '844G'
        ]   
);