PHPackages                             flagrow/flarum-api-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. flagrow/flarum-api-client

Abandoned → [maicol07/flarum-api-client](/?search=maicol07%2Fflarum-api-client)ArchivedLibrary[API Development](/categories/api)

flagrow/flarum-api-client
=========================

Standalone package for calling the API of a Flarum installation.

0.1.2(10y ago)255.3k↓50%8[4 issues](https://github.com/flagrow/flarum-api-client/issues)MITPHP

Since Jan 22Pushed 5y ago4 watchersCompare

[ Source](https://github.com/flagrow/flarum-api-client)[ Packagist](https://packagist.org/packages/flagrow/flarum-api-client)[ RSS](/packages/flagrow-flarum-api-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (7)Used By (0)

flarum-api-client by [![flagrow logo](https://avatars0.githubusercontent.com/u/16413865?v=3&s=15)](https://avatars0.githubusercontent.com/u/16413865?v=3&s=15) [flagrow](https://discuss.flarum.org/d/1832-flagrow-extension-developer-group)
=============================================================================================================================================================================================================================================

[](#flarum-api-client-by--flagrow)

[![Latest Stable Version](https://camo.githubusercontent.com/5389f714e87fb24bd1b0e413e6a5151beee967d8fc88115c4cb798cc30cc86fa/68747470733a2f2f706f7365722e707567782e6f72672f666c6167726f772f666c6172756d2d6170692d636c69656e742f762f737461626c65)](https://packagist.org/packages/flagrow/flarum-api-client) [![Gitter](https://camo.githubusercontent.com/b042d21962973e35d7d01506cf056dbb7e01f8850f70c70671880113432299ab/68747470733a2f2f6261646765732e6769747465722e696d2f666c6167726f772f666c6172756d2d6170692d636c69656e742e737667)](https://gitter.im/flagrow/chat)

This is a generic PHP API client for use in any project. You can simply include this package as a dependency to your project to use it.

### installation

[](#installation)

```
composer require flagrow/flarum-api-client
```

### configuration

[](#configuration)

In order to start working with the client you might need a Flarum master key:

1. Generate a 40 character random, unguessable string, this is the Token needed for this package.
2. Manually add it to the `api_keys` table using phpmyadmin/adminer or another solution.

The master key is required to access non-public discussions and running actions otherwise reserved for Flarum administrators.

### examples

[](#examples)

A basic example:

```