Flarum REST API UI

martinm

Hi!

I'm coming back to Flarum after a long time. After some research I still see it as a best option for a discussion board. I set up a community over at https://discuss.powersave.pro. As an automation person, working frequently with Airtable, Zapier, Pipedream and so on it seems like such a pity that the REST API is not straightforward to access.

If there was an extension or other kind of toggle in the admin and I could turn on the API, I could automate creating topics for every new release of my browser extension.

I'd have a workflow like Record in "published" statate in Airtable -> Send a request to Flarum -> Create a new topic with title X, body Y...

It would be a matter of a few mins.

But PHP and Docker are not part of my skillset and my forum currently runs at FreeFlarum so I couldn't probably even activate it, even if I wanted.

Maybe even first class support in platforms like Zapier, Make or Pipedream might work as a growth mechanism / marketing channel for the tool...

clarkwinkelmann

martinm Flarum REST API is always enabled, as it is used by the Flarum Single Page App. It's probably the same on FreeFlarum.

We have documentation on how to consume the API https://docs.flarum.org/rest-api

On FreeFlarum if you don't want to use an access token but prefer an API key, you can probably contact their support to have them create a key for you in your database.

martinm

clarkwinkelmann ah yes, I did not express the issue well, thank you. I did mean accessing the API token, I think it would be nice to have UI for that! I wonder how the official managed hosting for Flarum approaches it?

But yes, I think I'll make a donation to FreeFlarum and ask for a token from them

clarkwinkelmann

If you only want to create content as a specific user, you can use a Developer Access Token and you don't need an API Key. The API key must be created manually in the database, but for the Access Token you can create the user, login into the account and visit the Security tab to create a developer Access Token for that user.

EDIT: or at least I think there was a control there, but I don't see it on my account on Discuss and don't have access to my local Flarum copy at the moment. Maybe there was a permission to control who sees it.

You can create an Access Token from the REST API itself in any case, as described in the documentation.

luceos

API tokens connected to the user can be added from the Account Security page nowadays if the permission "Create access token" allows the user to do that.

A global api token that can act on behalf of anyone does have to be created manually inside the database still.

hf06

luceos Just to confirm is it enough for the admin to generate a token from the member settings page to start a discussion via the API on behalf of a standard member? I remember trying this and encountering an error, which is why I ended up creating the token manually

clarkwinkelmann

hf06 a user access token lets you do anything you could do while connected to that user in the Flarum web interface. Note that if the user is a regular user with the default post rate limit, creating posts via the API will also be rate limited. You can assign a special group to your user and set rate limit bypass in Flarum permissions tab.

If you have an error, please start a new support discussion with the error message so we can assist you.