https://github.com/orgmanager/php-orgmanager-api

A PHP client for the OrgManager API
https://github.com/orgmanager/php-orgmanager-api

api api-client client guzzle orgmanager orgmanager-api packagist php php-client

Last synced: about 1 month ago
JSON representation

A PHP client for the OrgManager API

• Host: GitHub
• URL: https://github.com/orgmanager/php-orgmanager-api
• Owner: orgmanager
• License: mpl-2.0
• Created: 2017-03-06T06:56:50.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-10-07T07:43:19.000Z (over 6 years ago)
• Last Synced: 2024-11-14T20:47:57.952Z (over 1 year ago)
• Topics: api, api-client, client, guzzle, orgmanager, orgmanager-api, packagist, php, php-client
• Language: PHP
• Size: 29.3 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# PHP OrgManager API Client

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/198c105f5e434fe2806b39a17d458dc3)](https://www.codacy.com/app/m1guelpiedrafita/php-orgmanager-api?utm_source=github.com&utm_medium=referral&utm_content=orgmanager/php-orgmanager-api&utm_campaign=badger)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/orgmanager/orgmanager-api.svg?style=flat-square)](https://packagist.org/packages/orgmanager/orgmanager-api)

[![Software License](https://img.shields.io/github/license/orgmanager/php-orgmanager-api.svg?style=flat-square)](LICENSE.md)

[![Build Status](https://img.shields.io/travis/orgmanager/php-orgmanager-api/master.svg?style=flat-square)](https://travis-ci.org/orgmanager/php-orgmanager-api)

[![Total Downloads](https://img.shields.io/packagist/dt/orgmanager/orgmanager-api.svg?style=flat-square)](https://packagist.org/packages/orgmanager/orgmanager-api)

This package makes it easy to interact with [the OrgManager API](https://github.com/orgmanager/orgmanager#api).

## Installation

You can install the package via composer:

``` bash

composer require orgmanager/orgmanager-api

```

## Usage

You must pass a Guzzle client and the API token to the constructor of `OrgManager\ApiClient\OrgManager`.

``` php

$orgmanager = new \OrgManager\ApiClient\OrgManager('YOUR_ORGMANAGER_API_TOKEN');

```

or you can skip the token and use the `connect()` method later

``` php

$orgmanager = new \OrgManager\ApiClient\OrgManager();

$orgmanager->connect('YOUR_ORGMANAGER_API_TOKEN');

```

### Get User info

``` php

$orgmanager->getUser();

```

### Get User Orgs

``` php

$orgmanager->getOrgs();

```

### Get Org info

``` php

$orgmanager->getOrg('ORG_ID');

```

### Change Org Password

``` php

$orgmanager->changeOrgPassword('ORG_ID', 'NEW_PASSWORD');

```

### Update Org

``` php

$orgmanager->updateOrg('ORG_ID');

```

### Delete Org

``` php

$orgmanager->deleteOrg('ORG_ID');

```

### Get Stats

``` php

$orgmanager->getStats();

```

### Renenerate Token

``` php

$orgmanager->regenerateToken($set);

```

where `$set` is false if you don't want to use the new token on future requests.

### Get the Guzzle Client

``` php

$orgmanager->getClient();

```

### Set the Guzzle Client

``` php

$client = new \GuzzleHttp\Client(); // Example Guzzle client

$orgmanager->setClient($client);

```

where $client is an instance of `\GuzzleHttp\Client`.

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash

$ composer test

```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover any security related issues, please email soy@miguelpiedrafita.com instead of using the issue tracker.

## Credits

- [Miguel Piedrafita](https://github.com/m1guelpf)

- [All Contributors](../../contributors)

## License

The Mozilla Public License 2.0 (MPL-2.0). Please see [License File](LICENSE.md) for more information.