Flarum API Client (PHP)

maicol07

Magnus_Lind sorry for the late reply (I've seen now the post 😅 ).
Currently, docs are lacking examples. However, there is some production ready code in PHPUnit tests...
Regarding your case you should pass an array as the post function parameter. To know what there should be inside you can examine Flarum via your browser developer tools (generally, press F12): when you create a post in a discussion you should see an XHR request in the network tab. Check the request params from there

Scumi

@maicol07
During my forum update to beta 15 I observed that I am not able to use the username (string) anymore when requesting a user via this api client.

$this->api->users($username)->request();

Using the id (int) however still works.

$this->api->users($userid)->request();

Can you confirm this? Maybe Flarums API has changed between beta 13 and beta 15.

tankerkiller125

Scumi This is accurate, we changed the way the API works in order to fix some other bugs and issues and also to be more compliant with the JSON-API specs. If you need to get a user by slug you can do so by adding the bySlug=true URL parameter. So something like example.com/api/users/<username>?bySlug=true I'm not sure how you would do that with this SDK/API but it is possible.

ctml

tankerkiller125 does this fix the issue where api query to a username starting with a number would try to look them up via userid?

E.g. Username 510889, user ID = 60
Query to user api for 510889 would return null unless you had that many users registered.

Scumi

Thanks, I can work with that.

tankerkiller125

ctml Yes, that would indeed be the fix. We actually originally just did this for the purpose of the custom slugging extender but the added side effect was fixing that bug. @010101 would be an example to test that it actually works correctly.

(Sorry @010101, you just are the example that comes to mind)

maicol07

Release 1.2.3

This small release fixes a bug with users API, when getting them by username/slug.

🛠️ Fixed

🐛 Get user by username returning 404 (beta15 incompatibility; thank you @Scumi for noticing this)

Note: Now the users endpoint parameter follows this standard:

int parameter: get user by id
string parameter: get user by slug/username

For example:
Parameter: 012453 - I get user with ID 012453
Parameter: '012453' - I get user with username 012453

This update shouldn't be a breaking update, so everything should work fine without anything else

maicol07

Release 1.3

This release focuses on adding minor features and removing support for Laravel 6 & 7 and Guzzle 6, in order to follow Flarum decisions with beta16. This changelog is a little different from the previous ones (new format! Tell me if you like it or the previous ones were better)

➕ Added

feat: ✨ Accept id as a string (for user endpoint) - The id() method can now accept a string parameters (like the user() method)
feat: ✨ `addQueryParameter` method is now public! - Public method = You can use it too! You can now add query parameters to the request

📈 Improved

docs: 📝 Updated docs and docs: 📝 Improved and added PHPDocs - New API docs website design. Some missing PHPDocs added and some updated.
tests: ✅ Updated tests

🗑️ Changed/Removed

chore(deps): 💥 📌 Removed support for Laravel 6 & 7. Requires PHP 7.3 - As commit says, now the api client requires PHP 7.3 and using it with Laravel 6 & 7 is no more supported. You can update or stick with version 1.2.3
chore(deps): 💥 Removed support for Guzzle 6 - Same as above.

zoocreative

Perhaps I am being an idiot here (not uncommon) but I can query Flarum with request() e.g. get a list of tags, but the returned items are protected and I can't seem to access them? Do I need to use a getter to view these items?

Cheers for any help.

maicol07

zoocreative the returned object is a Laravel collection, which is a better array implementation. You can use any of the collection methods to get elements. You can get the array with all the elements with the all() method (check the links to read more about collections).

zoocreative

maicol07 Ahh that falls into the category of me being an idiot 😄 thanks for the help, I knew it was bound to be something obvious but it just was not clicking with me. I'm new to Laravel too so I'll use that as my excuse!

maicol07

zoocreative no problem! 👍️

LF_Mcxixif_

I am new to Flarum, can you give me an example?I have set up api_key.

as follows:

Register a new user
Modify user avatar
Modify user password

thank you very much! 😀

maicol07

LF_Mcxixif_ hi! If you are trying to login/sign up users in Flarum you can take a look at my SSO extension. Anyway, you can check how to use it in the code I use for my extension:

Signup: https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/User/Traits/Auth.php#L93

User password: https://github.com/maicol07/flarum-sso-php-plugin/blob/master/src/User.php#L67-L69 (replace $this->getAttributes() with

[
    'password' => 'newpassword'
]

User avatar is a bit tricky because you can't change it only using Flarum REST api. My SSO extension has this feature built-in but basically you need to create an extension that creates a new endpoint, linked to a controller that downloads the avatar and uploads it (example).

Hope this helps you!

thimiraonline

Is this the only REST API that supports Flarum?

maicol07

thimiraonline as mentioned in your psot here the Flarum REST api endpoints are written in the table linked in that post. However, there have been some minor changes in the latest betas. Also extensions can extend the api endpoints by registering new ones

thimiraonline

maicol07 Is it possible to use this API to create a mobile app for Flarum?

maicol07

thimiraonline well, yes. Although some features may require support from an extension

thimiraonline

maicol07 That means?

maicol07

thimiraonline the API let you manage (create, modify, delete and get) discussions, posts, users, ...) These are the CRUD (Create, Retrieve, Update, Delete) endpoints. However, some Flarum features are not available by default via API so you need an extension to enable them

thimiraonline

maicol07 Ok, I will install it. Do you have full documentation for API. Then I can refer it before I create a app.

« Previous Page Next Page »