PHPackages                             pleio/pleio\_rest - 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. pleio/pleio\_rest

ActiveElgg-plugin[API Development](/categories/api)

pleio/pleio\_rest
=================

An API REST interface for the Pleio app.

33.3k2PHP

Since Oct 3Pushed 7y ago1 watchersCompare

[ Source](https://github.com/Pleio/pleio_rest)[ Packagist](https://packagist.org/packages/pleio/pleio_rest)[ RSS](/packages/pleio-pleio-rest/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Pleio REST API
==============

[](#pleio-rest-api)

This plugin provides an OAuth2.0 protected REST endpoint for third-party applications to an Elgg instance.

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

[](#installation)

Use the normal procedures to install and activate the Elgg plugin. During activation the plugin will create a the following new tables: oauth\_access\_tokens, oauth\_authorization\_codes, oauth\_clients, oauth\_jwt, oauth\_refresh\_tokens, oauth\_scopes, oauth\_users, elgg\_push\_notifications\_count and elgg\_push\_notifications\_subscriptions.

Configuration
-------------

[](#configuration)

To create a new OAuth2.0 client application insert a row into oauth\_client:

```
INSERT INTO oauth_clients ('client_id', 'client_secret', 'gcm_key', 'apns_cert') VALUES ('[my-client-id]', '[supersecret]', '[google-api-key]', '[apple-certificate-and-private-key]');

```

The client\_id and client\_secret have to be configured in the OAuth2.0 client as well. Optionally iOS and Android push notifications of new river objects to group members can be configured by setting \[google-api-key\] to the Google Cloud Messaging (GCM) API key and \[apple-certificate-and-private-key\] to the Apple Push certificate and private key. To generate the Apple certificate and private key export them from your Apple Keychain and use the following commands:

```
openssl x509 -in pleioapp-development.cer -inform der -out pleioapp-development.crt
openssl pkcs12 -nocerts -nodes -in pleioapp-development.p12 -out pleioapp-development.key
Enter Import Password:
MAC verified OK

cat pleioapp-development.crt pleioapp-development.key

```

Paste the output into the apns\_cert field of oauth\_clients.

To receive notifications, applications register to the API by calling the /api/user/register\_push endpoint.

Version information and documentation
-------------------------------------

[](#version-information-and-documentation)

Version information can be found at https://\[your-elgg-instance\]/api. To view the most recent API documentation check out https://\[your-elgg-instance\]/api/doc with the [Swagger API browser](petstore.swagger.io/).

Regenerate API documentation
----------------------------

[](#regenerate-api-documentation)

To regenerate the Documentation is automatically generated by [swagger-php](https://github.com/zircote/swagger-php). Use

```
composer global require zircote/swagger-php

```

to install this package globally. Then run

```
~/.composer/vendor/bin/swagger

```

inside this plugin folder to generate swagger.json.

REST calls
----------

[](#rest-calls)

Authorization is done by using OAuth2 access tokens. Request a new access token like:

```
curl  --data "client_id=pleioapp&client_secret=as389sfj3lkjsf3&username=admin&password=adminadmin&grant_type=password" http://www.pleio.dev/oauth/v2/token

```

Then perform authenticated requests like this:

```
curl -v -H "Authorization: Bearer " https://www.pleio.dev/api/groups

```

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 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.

### Community

Maintainers

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

---

Top Contributors

[![bartjkdp](https://avatars.githubusercontent.com/u/5213690?v=4)](https://github.com/bartjkdp "bartjkdp (72 commits)")

### Embed Badge

![Health badge](/badges/pleio-pleio-rest/health.svg)

```
[![Health](https://phpackages.com/badges/pleio-pleio-rest/health.svg)](https://phpackages.com/packages/pleio-pleio-rest)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M453](/packages/google-gax)

PHPackages © 2026

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