PHPackages                             ocolin/calix-axos-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. ocolin/calix-axos-client

ActiveLibrary[HTTP & Networking](/categories/http)

ocolin/calix-axos-client
========================

Basic REST Client for Calix AXOS SMx Northbound server

1.3(5mo ago)05MITPHPPHP >=8.3

Since Nov 13Pushed 5mo ago1 watchersCompare

[ Source](https://github.com/ocolin/CalixAxosClient)[ Packagist](https://packagist.org/packages/ocolin/calix-axos-client)[ RSS](/packages/ocolin-calix-axos-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (4)Versions (5)Used By (0)

Calix Axos Client
=================

[](#calix-axos-client)

A small PHP REST Client for Calix AXOS.

Instantiation
-------------

[](#instantiation)

First we must instantiate a client and provide it with a URL for the server, as well as a username and password to authenticate with the server. These can also be provided by environment variables instead of constructor arguments.

### Constructor arguments

[](#constructor-arguments)

- url - The URL and port to the AXOS server.
- username - Username of account making the API calls.
- password - Password of account making API calls.
- timeout - HTTP timeout in seconds. Defaults to 20 seconds.
- verify - Verify SSL connection. Defaults to off.

### Environment variables

[](#environment-variables)

- SMX\_HOST - URL of AXOS REST server, including port.
- SMX\_USERNAME - Username on server to login as.
- SMX\_PASSWORD - Password of user to login as.

### Example with environment variables

[](#example-with-environment-variables)

```
$_ENV['SMX_HOST'] = 'https://server.com:18443/rest/v1/';
$_ENV['SMX_USERNAME'] = 'myuser';
$_ENV['SMX_PASSWORD'] = '123456'

$client = new Ocolin\Calix\Axos\Client();
```

### Example - Environment with optional parameters

[](#example---environment-with-optional-parameters)

```
$_ENV['SMX_HOST'] = 'https://server.com:18443/rest/v1/';
$_ENV['SMX_USERNAME'] = 'myuser';
$_ENV['SMX_PASSWORD'] = '123456'

$client = new Ocolin\Calix\Axos\Client(
    timeout: 100,
     verify: true,
);
```

### Example - Using constructor arguments

[](#example---using-constructor-arguments)

```
$client = new Ocolin\Calix\Axos\Client(
    url: 'https://server.com:18443/rest/v1/',
    username: 'myuser',
    password: '123456'
);
```

Making API calls
----------------

[](#making-api-calls)

### Full

[](#full)

This function will return an object containing:

- HTTP status code
- HTTP status message
- HTTP headers
- HTTP response body

### Call

[](#call)

This is the same as full, but will return only the response body.

### Example GET

[](#example-get)

```
$output = $client->call(
    path: '/ems/subscriber/org/{org-id}/account/{account-name}',
    query: [
        'orig-id' => 'Calix',
        'account-name' => 123
    ]
);
```

### Example POST (Create)

[](#example-post-create)

```
$output = $client->call(
    path: '/ems/subscriber',
    method: 'POST',
    body: [
        'name' => 'PHPUnit test',
                'customId' => 777,
                'type' => 'Residential',
                'orgId' => 'Calix',
                'locations' => [ ... ]
    ]
);
```

### Example PUT (Update)

[](#example-put-update)

```
$output = $client->call(
    path: '/ems/subscriber/org/{org-id}/account/{account-name}',
    method: 'PUT',
    query: [
        'orig-id' => 'Calix',
        'account-name' => 123
    ]
    body: [
        'name' => 'New name',
        'orgId' => 'Calix',
        'customId' => 123,
    ]
);
```

### Example DELETE

[](#example-delete)

```
$output = $client->call(
    path: '/ems/subscriber/org/{org-id}/account/{account-name}',
    method: 'DELETE',
    query: [
        'orig-id' => 'Calix',
        'account-name' => 123
    ]
);
```

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance70

Regular maintenance activity

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

4

Last Release

175d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e97ac0aa452b872ddc3f7f4c56c83852574a27bb74622f8c054d11ca20008fc9?d=identicon)[Ocolin](/maintainers/Ocolin)

---

Top Contributors

[![ocolin](https://avatars.githubusercontent.com/u/8870196?v=4)](https://github.com/ocolin "ocolin (2 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/ocolin-calix-axos-client/health.svg)

```
[![Health](https://phpackages.com/badges/ocolin-calix-axos-client/health.svg)](https://phpackages.com/packages/ocolin-calix-axos-client)
```

###  Alternatives

[spatie/crawler

Crawl all internal links found on a website

2.8k16.3M52](/packages/spatie-crawler)[omniphx/forrest

A Laravel library for Salesforce

2724.4M8](/packages/omniphx-forrest)[akamai-open/edgegrid-client

Implements the Akamai {OPEN} EdgeGrid Authentication specified by https://developer.akamai.com/introduction/Client\_Auth.html

482.5M6](/packages/akamai-open-edgegrid-client)[muhammadhuzaifa/telescope-guzzle-watcher

Telescope Guzzle Watcher provide a custom watcher for intercepting http requests made via guzzlehttp/guzzle php library. The package uses the on\_stats request option for extracting the request/response data. The watcher intercept and log the request into the Laravel Telescope HTTP Client Watcher.

98239.8k1](/packages/muhammadhuzaifa-telescope-guzzle-watcher)[ory/hydra-client-php

Documentation for all of Ory Hydra's APIs.

1710.8k](/packages/ory-hydra-client-php)[meteocontrol/vcom-api-client

HTTP Client for meteocontrol's VCOM API - The VCOM API enables you to directly access your data on the meteocontrol platform.

175.7k1](/packages/meteocontrol-vcom-api-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)