PHPackages                             om-hosting/openmeetings-php-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. [API Development](/categories/api)
4. /
5. om-hosting/openmeetings-php-client

ActiveLibrary[API Development](/categories/api)

om-hosting/openmeetings-php-client
==================================

OpenMeetings PHP package to expose OpenMeetings Rest API - see https://openmeetings.apache.org/swagger/

2.0.0(4y ago)32351Apache-2.0PHPPHP >=5.5

Since Sep 18Pushed 4y ago2 watchersCompare

[ Source](https://github.com/om-hosting/openmeetings-php-client)[ Packagist](https://packagist.org/packages/om-hosting/openmeetings-php-client)[ Docs](https://github.com/om-hosting/openmeetings-php-client)[ RSS](/packages/om-hosting-openmeetings-php-client/feed)WikiDiscussions master Synced 1mo ago

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

openmeetings-php-client
=======================

[](#openmeetings-php-client)

[![Packagist License](https://camo.githubusercontent.com/8894fb084f88504658fc065aaf8d054a86c52a7aad89aa1690471a8ab445691d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6f6d2d686f7374696e672f6f70656e6d656574696e67732d7068702d636c69656e74)](https://camo.githubusercontent.com/8894fb084f88504658fc065aaf8d054a86c52a7aad89aa1690471a8ab445691d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6f6d2d686f7374696e672f6f70656e6d656574696e67732d7068702d636c69656e74)[![GitHub issues](https://camo.githubusercontent.com/265331a2b1e01b36d08e2fe3c7f427ae4c9c551b147c09d9bb823909f776b1a6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6f6d2d686f7374696e672f6f70656e6d656574696e67732d7068702d636c69656e74)](https://camo.githubusercontent.com/265331a2b1e01b36d08e2fe3c7f427ae4c9c551b147c09d9bb823909f776b1a6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6f6d2d686f7374696e672f6f70656e6d656574696e67732d7068702d636c69656e74)[![Packagist Version](https://camo.githubusercontent.com/3c8795db37c1bac8aab687df879f7d8d52280035896f52c8682313bb1eba0389/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6f6d2d686f7374696e672f6f70656e6d656574696e67732d7068702d636c69656e74)](https://camo.githubusercontent.com/3c8795db37c1bac8aab687df879f7d8d52280035896f52c8682313bb1eba0389/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6f6d2d686f7374696e672f6f70656e6d656574696e67732d7068702d636c69656e74)[![Packagist Downloads](https://camo.githubusercontent.com/b48a8c080965b7b3e7a61371305716641cde6ac23c2e1d67558afedf060f91fa/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f6f6d2d686f7374696e672f6f70656e6d656574696e67732d7068702d636c69656e74)](https://camo.githubusercontent.com/b48a8c080965b7b3e7a61371305716641cde6ac23c2e1d67558afedf060f91fa/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f6f6d2d686f7374696e672f6f70656e6d656574696e67732d7068702d636c69656e74)

PHP composer managed package to connect to OpenMeetings REST API ().

See also:

Example use case
----------------

[](#example-use-case)

See the example use case at:

Version and compatibility
-------------------------

[](#version-and-compatibility)

openmeetings-php-clientdescriptionversion 1.x.xGuzzle v 6.x.xversion 2.x.xGuzzle v 7.x.x and laterInstallation
------------

[](#installation)

Install packagist package:

```
php composer.phar install openmeetings-php-client
```

Usage: Example usage:

```
        $BASE_URL = "http://localhost:5080/openmeetings";

        //1. Login to service
        $config = new Configuration();
        $config->setHost($BASE_URL . '/services');
        $userApiInstance = new UserServiceApi(null, $config);
        $serviceResultLoginWrapper = $userApiInstance->login("soapuser", "!HansHans1");
        if ($serviceResultLoginWrapper->getServiceResult()->getType() != "SUCCESS") {
            $text = "Login Failed " . $serviceResultLoginWrapper->getServiceResult()->getMessage();
            return view('hello_index', ['text' => $text]);
        }
        $sid = $serviceResultLoginWrapper->getServiceResult()->getMessage();

        // 2. Generate Hash for entering a conference room
        $serviceResultHashWrapper = $userApiInstance->getRoomHash($sid,
            new ExternalUserDTO(
                array(
                    "firstname" => "John",
                    "lastname" => "Doe",
                    "external_id" => "uniqueId1",
                    "external_type" => "myCMS",
                    "login" => "john.doe",
                    "email" => "john.doe@gmail.com"
                )
            ),
            new RoomOptionsDTO(
                array(
                    "room_id" => 2,
                    "moderator" => true
                )
            )
        );

        // 3. Construct Login URL
        $hash = $serviceResultHashWrapper->getServiceResult()->getMessage();
        $url = $this->BASE_URL . "/hash?secure=".$hash;
```

See also example project code at:

Description
-----------

[](#description)

Integration API enables to connect to an OpenMeetings instance, eg for generating users, create links to directly access conference rooms.

**It is mainly designed for Server2Server integration, for example to integrate into your website, CMS or 3rd party application**

For examples how to use the Rest API see .

Community contributed modules for using this API include for example:

-

Other community plugins using this API for Moodle, SugarCRM, Drupal, Joomla can be found in the Configuration>Plugins section at

Initial version of this PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 7.0.0-SNAPSHOT
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen For more information, please visit

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

[](#requirements)

PHP 5.5 and later

Installation & Usage
------------------------

[](#installation--usage)

### Composer

[](#composer)

To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:

```
{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/om-hosting/openmeetings-php-client.git"
    }
  ],
  "require": {
    "om-hosting/openmeetings-php-client": "*@dev"
  }
}

```

Then run `composer install`

### Manual Installation

[](#manual-installation)

Download the files and include `autoload.php`:

```
    require_once('/path/to/openmeetings-php-client/vendor/autoload.php');
```

Tests
-----

[](#tests)

To run the unit tests:

```
composer install
./vendor/bin/phpunit

```

Getting Started
---------------

[](#getting-started)

Please follow the [installation procedure](#installation--usage) and then run the following:

```