REST API Questions

zethon

I have an app that is sort of like Outlook for message boards (or a desktop version of Tapatalk) and I am trying to add Flarum support using Flarum's REST API, but I have a couple of questions:

First, is the REST API fully implemented yet? I have notice that a lot of the API calls (like /api/discussions and /api/posts and /api/users) don't work, while some work fine (/api/token, /api/forum, /api/groups) but I am not sure if this is a misconfiguration on my board (now that I think about it, I should try it here) or if it's just the state of the REST API is in as of now.

Second, in the REST API docs I see no way to get a list of tags For giggles I tried GET /api/tags (since there is no GET method defined in the docs) but that did not work. Is this an oversight? Is there something I'm misunderstanding?

Third, I love what I see of this software so far! Not a question, just positive feedback. 🙂

Thank you!

luceos

zethon Flarum is in beta, so yes a lot of that might be broken, missing or incomplete 😉

Franz

zethon I have notice that a lot of the API calls (like /api/discussions and /api/posts and /api/users) don't work

What exactly doesn't work? They should work just fine... We cannot guarantee at this time that some endpoints may still change, but the ones we have right now should work.

zethon Second, in the REST API docs I see no way to get a list of tags For giggles I tried GET /api/tags (since there is no GET method defined in the docs) but that did not work. Is this an oversight? Is there something I'm misunderstanding?

Yep, looks like we didn't add a GET route for tags in the tags extension. Is that a feature request? 😉

zethon

Franz

Ok,I think I've figured out the problem. It seems that the REST API does not honor the user's group permissions. For example, my main board (which uses vBulletin) I have closed to the public, so for my Flarum test board, I mimic that privacy. So, I had this set in the Admin settings:

And even tho the user I was logging in as had permission to see everything, if I logged in with that user through the REST API, several of the REST calls were not working (some were returning 401, others were returning "{ data: [0] }").

Once I changed that setting to "Everyone", the REST API worked. This sounds like a bug, correct? (I can log it in GitHub if you'd like)....

And also, yes, yes yes! Please implement a way to list tags! 🙂

Franz

zethon Yep, please submit a bug report on GitHub.

For the GET tags endpoint, please also submit an issue. 🙂

Toby

Also you can currently get the tags via /api/forum

zethon

Toby

Ahh.. you're right. Tho, they don't seem to be returned if "View Discussions" is set to "Members" (probably related to the bug mentioned above and that I just logged on GitHub).

zethon

I'm looking at the tag information returned by /api/forum. Would it be fair to say that the "canStartDiscussion" property denotes a primary tag of true?

Toby

zethon A tag is a primary tag if position !== null.

Tai

@Toby In API discusison, how to get contentHtml in relationships/startPost.

marcozambi

Hello there!
I'm trying the very first step, trying to obtain a token.
My POST requests receives an error in return, as follows.
What am I doing wrong?

Httpful\Response Object ( 
	[body] => stdClass Object (
		 [errors] => Array ( 
			[0] => stdClass Object ( 
				[status] => 405 [code] => method_not_allowed )
		 )
	 )
	 [raw_body] => {"errors":[{"status":"405","code":"method_not_allowed"}]} 
...

Franz

marcozambi This means you are sending a POST request to an endpoint that does not support POST requests. Can you provide the URL?