Logs user out in Joomla 3.9.X about com_api

[grantg182]

Upon further investigation, it appears this is broken from Joomla 3.8 onwards.

In my custom plugin, I have the following basic structure:- /plugins/api/customapi/custom.php:-

class plgAPICustomApi extends ApiPlugin
{
        public function __construct(&$subject, $config = array())
        {
                parent::__construct($subject, $config = array());

                //load helper file
                require_once JPATH_SITE.'/plugins/api/customapi/playlists/helper/simpleschema.php';

                ApiResource::addIncludePath(dirname(__FILE__).'/customapi');

                // Set resources & access
                $this->setResourceAccess('custom', 'public', 'get');
        }
}

/plugins/api/customapi/custom.php:-

class CustomApiApiResourceCustom extends ApiResource
{

        /**
         * get Method to get custom object
         *
         * @return  JSON Object
         *
         * @since  1.0
         */
        public function get()
        {
                $this->plugin->setResponse($this->getCustomObject());
        }
        public function getCustomObject() 
        {
                // my code to get article data and process 3rd party apps.
        }
}

My getCustomObject() function gets some data from the current viewed article. I am calling the custom API from an AJAX request.

I have since discovered that if I create an API key and hardcode this as an Authentication: Bearer header in the AJAX request, that I remain logged in. However, this is of no use - I literally do not care about authentication, whether the user is logged in or not, hence setResourceAccess is set to public.

What is the best way forward? Some, not all, of my "users" will be logged in, but I need the api to return the same data irrespective if they are logged in or not - so do not need nor wish to have to create an API token on the fly for each "user".

[coolbung]

If you are sure that you will be using the API calls on the same Joomal site where the user is logged in, then you can set the X-Auth header to session.

However, usually if it is the same site, you can just create a controller.json.php instead of creating an API plugin.

[coolbung]

Closing this, please reopen in case you continue to face issues even with the approach suggested above.