PHPackages                             yusu/unioncloud-api-php - 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. [API Development](/categories/api)
4. /
5. yusu/unioncloud-api-php

AbandonedArchivedLibrary[API Development](/categories/api)

yusu/unioncloud-api-php
=======================

A wrapper to allow integration with the APIs of the UnionCloud platform operated by NUS.

v0.2.0(8y ago)1501[3 issues](https://github.com/YUSU/unioncloud-api-php/issues)[1 PRs](https://github.com/YUSU/unioncloud-api-php/pulls)PHPPHP >=5.5.0

Since Mar 25Pushed 3y agoCompare

[ Source](https://github.com/YUSU/unioncloud-api-php)[ Packagist](https://packagist.org/packages/yusu/unioncloud-api-php)[ RSS](/packages/yusu-unioncloud-api-php/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (3)Dependencies (2)Versions (4)Used By (0)

UnionCloud API Wrapper (PHP)
============================

[](#unioncloud-api-wrapper-php)

By [Liam McDaid, University of York Students' Union (YUSU)](http://www.yusu.org)

**Please Note this is no longer maintained by YUSU**

A wrapper to allow integration with the APIs of the [UnionCloud](http://www.unioncloud.co.uk) platform operated by NUS.

**WARNING:** The apis are at Union level and should only be used by the Union. Access to the apis should not be given to any student groups under any circumstances.

Requirements
------------

[](#requirements)

- PHP5.5+
- [Composer](https://getcomposer.org/)

Installation
------------

[](#installation)

Add `yusu/unioncloud-api-php` as a require dependency in your `composer.json` file:

```
composer require yusu/unioncloud-api-php
```

Usage
-----

[](#usage)

Create an instance of the api wrapper and tell it which site to use

```
use UnionCloud\Api;
$api = new Api();
$api->setHost("www.yusu.org");
```

You can inject debug info about the request into the response by passing `"include_debug_info" => true` in either the constructor

```
$api = new Api(["include_debug_info" => true]);
```

or

```
$api->setOptions(["include_debug_info" => true]);
```

### Authenticating

[](#authenticating)

You need to authenticate before you are able to make any api calls

```
$api->authenticate($user_email, $user_password, $app_id, $app_password);
```

`$app_id` and `$app_password` can be created via your unions dashboard ( **Admin** > **Setup** > **Developers** )

`$user_email` and `$user_password` should be the login details of a valid user for your union that has the permissions to access the apis. **Note:** This should be a service account. Its best to contact NUS via Zendesk to get setup with these as there are some other settings which need to be enabled for the apis to work.

```
$api->setAuthToken($auth_token, $expiry_timestamp);
```

### Making API calls

[](#making-api-calls)

Once you have successfully authenticated you are able to make api calls using the wrapper. Please consult the documentation apiary and the methods which this wrapper exposes to make calls. A few examples are given below:

```
// users
$users = $api->users();
$user = $api->user_search(["id" => "lm638"]);

// events
$events = $api->events();
$event = $api->event_get($event_id);
$api->event_update($event_id, ["event_name" => "New Event Name"]);

// groups
$groups = $api->groups();
```

Change Log
----------

[](#change-log)

### \[0.2.0\] 12th October 2017

[](#020-12th-october-2017)

- Fix issue ca-cert in macOS
- Reduce dependency on php to 5

### \[0.1.0\] 25th March 2017

[](#010-25th-march-2017)

- Corrected: version of a required dependency in composer.json

### \[0.1.0\] 25th March 2017

[](#010-25th-march-2017-1)

- New Project created
- Added: Goutte to handle making the api calls
- Added: All current apis
- Added: Apis throw exceptions when errors are detected
- Added: Option to show debug information about the request (including any pagination info)

###  Health Score

20

—

LowBetter than 13% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 87.5% 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 ~201 days

Total

2

Last Release

3184d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/7586600?v=4)[Liam McDaid](/maintainers/liammcdaid)[@liammcdaid](https://github.com/liammcdaid)

---

Top Contributors

[![liammcdaid](https://avatars.githubusercontent.com/u/7586600?v=4)](https://github.com/liammcdaid "liammcdaid (7 commits)")[![orryverducci](https://avatars.githubusercontent.com/u/977052?v=4)](https://github.com/orryverducci "orryverducci (1 commits)")

### Embed Badge

![Health badge](/badges/yusu-unioncloud-api-php/health.svg)

```
[![Health](https://phpackages.com/badges/yusu-unioncloud-api-php/health.svg)](https://phpackages.com/packages/yusu-unioncloud-api-php)
```

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.8k3.6M957](/packages/statamic-cms)[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

3.0k37.6M129](/packages/darkaonline-l5-swagger)[knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

2.3k14.2M62](/packages/knuckleswtf-scribe)[kyon147/laravel-shopify

Shopify package for Laravel to aide in app development

485302.1k](/packages/kyon147-laravel-shopify)[statamic-rad-pack/runway

Eloquently manage your database models in Statamic.

135224.7k7](/packages/statamic-rad-pack-runway)[justbetter/laravel-magento-client

A client to interact with Magento

50111.9k15](/packages/justbetter-laravel-magento-client)

PHPackages © 2026

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