Using the API

wmchen

Hi Flarum community,

I tried to use the flarum api based on the guideline in the FAQ. I wrote a simple script of curl_post/curl_get to retrieve data from the official flarum (e.g., https://discuss.flarum.org/api/token). It worked as well and allowed me to output the token and usedId as below:

stdClass Object
(
[token] => j4lL46yXzVkja6VSawnDQKXAxhPR0wWjfZfxZvEA
[userId] => 14721
)

However, I don't know why it printed NULL via the same script neither GET or POST when I tested the flarum I installed in my server.

I tested it in another well to GET data directed from browser url (http://my-server-ip/forum/api/users), it worked as well.

How should I do?

luceos

wmchen you have to create a master token, see the documentation here:

https://github.com/flagrow/flarum-api-client#configuration

Then in your request use:

Authorization: Token <masterToken>; userId=<1 for admin or any other>

wmchen

luceos I tried to composer "flagrow/flarum-api-client", but it couldn't download files completely. So I turned to git clone 'flagrow/flarum-api-client' instead.

I inserted a random master-key in api-key table, and then ran the script based on basic example, but I got the error message below:

PHP Fatal error: Uncaught GuzzleHttp\Exception\ClientException: Client error: GET http://localhost/forum/api/discussions resulted in a 404 Not Found response:

<html>
<head><title>404 - No Such Resource</title></head>
<body>
<h1>No Such Resource</h1>
<p>No such child (truncated...)
in /home/wmchen/www/forum/vendor/guzzlehttp/guzzle/src/Exception/RequestException.php:113
Stack trace:
#0 /home/wmchen/www/forum/vendor/guzzlehttp/guzzle/src/Middleware.php(65): GuzzleHttp\Exception\RequestException::create(Object(GuzzleHttp\Psr7\Request), Object(GuzzleHttp\Psr7\Response))
#1 /home/wmchen/www/forum/vendor/guzzlehttp/promises/src/Promise.php(203): GuzzleHttp\Middleware::GuzzleHttp{closure}(Object(GuzzleHttp\Psr7\Response))
#2 /home/wmchen/www/forum/vendor/guzzlehttp/promises/src/Promise.php(156): GuzzleHttp\Promise\Promise::callHandler(1, Object(GuzzleHttp\Psr7\Response), Array)
#3 /home/wmchen/www/forum/vendor/guzzlehttp/promises/src/Tas in /home/wmchen/www/forum/vendor/guzzlehttp/guzzle/src/Exception/RequestException.php on line 113

Did I got anything wrong?

Here is my script:

<?php

require_once "vendor/autoload.php";

use Flagrow\Flarum\Api\Flarum;

$api = new Flarum('http://localhost/forum', ['token' => 'YACub3KLfe8mfmHPcUKtt6t2SMJOGPXnZbqhc3nX; userId=1']);

// A collection of discussions from the first page of your Forum index.
$discussions = $api->discussions()->request();
// Read a specific discussion.
$discussion = $api->discussions()->id(1)->request();
// Read the first page of users.
$users = $api->users()->request();

var_dump($users);

luceos

Is your forum located at http://localhost/forum showing a discussion index?

wmchen

luceos Sorry for my incorrect post. I have to correct the address, it should be http://my-server-ip/forum.

wmchen

wmchen I just gave it a try. If I changed the IP address to localhost. It's allowed me to GET data from disscussions but have a permission denied when GET http://localhost/forum/api/users.

If IP address is external IP, it showed errors as I posted in the beginning.

luceos

wmchen have you checked the permission to "allow user list" or something in the permissions table in the admin area? It's (only) related to hitting the api users endpoint.

wmchen

luceos No idea what's happened to me, After I re-inserted a master-key into the api-key table, it works so far so good in localhost.

But there still has a error as above when retrieving data via external ip.

Should I have to open some ports? The ports I opened are 80, 443, 8080, 22, 3306, that's all.

wmchen

luceos The wired thing I found is that it worked via IP address but does NOT work via domain name.
How can I have to do?

luceos

wmchen localhost is only accessible to your own local machine, it informs your machine that it should hit the current host. If you want to make the api accessible from the outside you'd have to set up some dns or resolving.

Unless I don't understand your question ?

wmchen

luceos You are right. After I checked the server environment setting, I did have a DNS resolving problem. Thank you very much! Now it totally works as well.

Have you some information for me to integrate with flarum with existing website?

luceos

wmchen Have you some information for me to integrate with flarum with existing website?

Single sign on? Try flagrow/passport and an oauth2 client or server implementation; league has both.

wmchen

luceos Thanks for your nice information. I will close this session. If I meet any issue in the near future, I will open another discussion.

Thanks!

flutterforum

Hello to everyone
I want to work with API but I got the error
my code:
<?php require_once "vendor/autoload.php"; use Flagrow\Flarum\Api\Flarum; $api = new Flarum('http://localhost/', ['token' => '1WIJgZqkOTww2u1IoKpb26WcXrxsDDWpJOOqa6P1; userId=1']); // A collection of discussions from the first page of your Forum index. $discussions = $api->discussions()->request(); // Read a specific discussion. $discussion = $api->discussions()->id(1)->request(); // Read the first page of users. $users = $api->users()->request(); var_dump($users); ?>
Sql data : http://prntscr.com/mh1xyp
Thank you!

Tirual

flutterforum If you get this to work can't you send the fix to me too, im having problem with this too!

luceos

What error do you get?