Difference between revisions of "API PHP Wrapper"
From UnionCloud Support
Liammcdaid (talk | contribs) m |
m (Spelling/ Grammar Include > Includes) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 10: | Line 10: | ||
== Getting Started== | == Getting Started== | ||
| − | The api's are mostly documented on [http://docs.ucapi.apiary.io/ apiary.io]. You will need to create an account on apiary, then submit a support ticket to gain access to the documentation. The developer team keep this up to date and it | + | The api's are mostly documented on [http://docs.ucapi.apiary.io/ apiary.io]. You will need to create an account on apiary, then submit a support ticket to gain access to the documentation. The developer team keep this up to date and it includes example calls which show what you can get from the system by varying the paramters. |
Its best to test out the api functionality in the UAT environment first, so not to effect the production site. | Its best to test out the api functionality in the UAT environment first, so not to effect the production site. | ||
| Line 16: | Line 16: | ||
==Wrappers== | ==Wrappers== | ||
===PHP=== | ===PHP=== | ||
| − | [http://www.yusu.org YUSU] have created a wrapper for PHP which can be installed via composer [https://packagist.org/packages/yusu/ | + | [http://www.yusu.org YUSU] have created a wrapper for PHP which can be installed via composer [https://packagist.org/packages/yusu/unioncloud-api-php yusu/unioncloud-api-php]. This is an second version and replaces the existing api wrapper. |
Latest revision as of 13:50, 7 February 2018
A number of api's have been created to allow programmatic access to the UnionCloud platform.
- Authentication
- Uploads
- Users
- UserGroup / UserGroup Memberships
- Events
- Elections
- Groups (to be released soon)
Getting Started
The api's are mostly documented on apiary.io. You will need to create an account on apiary, then submit a support ticket to gain access to the documentation. The developer team keep this up to date and it includes example calls which show what you can get from the system by varying the paramters.
Its best to test out the api functionality in the UAT environment first, so not to effect the production site.
Wrappers
PHP
YUSU have created a wrapper for PHP which can be installed via composer yusu/unioncloud-api-php. This is an second version and replaces the existing api wrapper.
