api

Posts' Comments

For the new API in UNA 13.1 we'll add more documentation later, but for short, all endpoints looks like this:

https://example.com/api.php?r={service_name}&params[]={service_params}

Where:

{service_name} - is any allowed service name in the form - module/function/optinal_class, for example: system/get_page/TemplServicePages
{service_params} - is optional params, for example, for the above get_page method, it could be about string, so full API endpoint to get About page looks like this: https://example.com/api.php?r=system/get_page/TemplServicePages&params[]=about

Depending on the settings, you need to pass Authorization header, for example: Authorization: Bearer {secure_string}

Where {secure_string} is a key generated in Studio > API > Keys

Great list of most service calls can be found in UNA autogenerated documentation in Service Calls section

#tipsandtricks #api

Discussions

Api

Приветствую 🤝 , что такое api в una для чего#api

Forum's Comments

To add custom API endpoint to UNA, please create an empty module first, I think it's better to rename modules/boonex/api module to your own and delete or replace existing endpoints with yours.

To add custom endpoint - add service function, for example to add endpoint which get time you can add something like this:

public function serviceClock() 
{
    return ['time' => date('H:i:s')];
}

Then declare if you want to use this endpoint with authentication or not, for public endpoint add name of the endpoint to serviceGetPublicServices method:

public function serviceGetPublicServices()
{
    $a = parent::serviceGetPublicServices();
    return array_merge($a, array ('Clock' => ''));
}

for protected endpoint add it the same way but to serviceGetSafeServices method.

After above you will be able to call your custom endpoint with the following URL:

http://example.com/m/oauth2/com/clock?client_id=1234abcd&module=your_modulename

You will get response in JSON format

#tipsandtricks #api

Empty

Followers

Empty

Post to api