On click of custom button , how can I call API ?

Hi Gautam.

The next guide can you help on this topic:

https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_10.3/Cookbook/Adding_Buttons_to_the_Record_View/

Kind regards.

Hi Sanchez ,

Link which you have shared helped me to create a button and do some action on click of it. But I want to call an API on click of that button.

Hi.

can you show me the function registerApiRest of your endpoint?

Yes sure . Please find it below :

public function registerApiRest()
{
return array(
//GET
'MyGetEndpoint' => array(
//request type
'reqType' => 'GET',

//set authentication
'noLoginRequired' => false,

//endpoint path
'path' => array('Accounts', 'mycustomeAPI'),

//endpoint variables
'pathVars' => array('', '', 'id'),

//method to call
'method' => 'mycustomeMethod',

//short help string to be displayed in the help documentation
'shortHelp' => 'get all Cusotmer By Customer ID in SugarCRM',

//long help to be displayed in the help documentation
'longHelp' => '',
)
);
}

Thanks.

Sanchez Jorge Luis was right to ask you for the definition, you are missing a variable in the path for the id taht you are passing.

in general, the number of elements in your path need to equal the number of elements int he path vars.

your path should be:

'path' => array('Accounts', 'mycustomeAPI', ?),

Yeah  and the code the api.call must be change from 'update' to 'read', because is a action type 'GET'

app.api.call('read', app.api.buildURL('Accounts/mycustomAPI/' + this.model.get('id')), null {

What should be the  'path' then ?

Can i make it like this : 

path' => array('Accounts', 'mycustomeAPI', id),

No it should have the question mark, as I stated above.

See:
support.sugarcrm.com/.../

app.api.call('update',url,params,{...}); 

what is the params here ? What is the use of this ? 

I am new to it so please spare me..

The question mark indicates a placeholder for the input, the path_vars then name that placeholder.

Path_vars are in the same order as the path

So the first two in your path do not have an associated variable, but the third one does: id.

if you had two varialbles, you would have two placeholders.

This is for a GET method of course.

Hope this helps clarify. 

Thanks Francesca, for the information and I have some better  understanding now.

<<Question>>

app.api.call('update',url,params,{...});

What is param here ?  What is the use of this ? 

There are essentially two ways to pass parameters in an API, one is in the url itself, and one is in the request body.

The "param" in the example above are the parameters which are passed in the request body, and received by the custom api accordingly.

See if you can find a primer on APIs that you can read through to familiarize yourself with the different methods and parameters. It will help. 

Hi Francesca,

I am not getting any response on click of button. No alert message. Also not sure whether data is coming back or not .  Please refer codes below: 

Path modified :
path' => array('Accounts', 'mycustomeAPI', '?')

(Used in Postman) [checked in postman I am getting a response]
API URL : http://{{CRM_URL}}/sugarcrm/rest/v10/Accounts/mycustomAPI/?id=62aace7c-8729-11eb-a0e4-0e1a95bf95b1

record.js
custom_button:function(){
app.api.call('read', app.api.buildURL('Accounts/mycustomAPI/' + this.model.get('id')), null{
success:function(fdata)
{
app.alert.show('Activation-Initiated', {
level: 'error',
messages: 'Customer Is Activated.',
autoClose: false
});
},
error: function(error){
app.alert.show('err', {
level:'error',
title: app.lang.getAppString('ERR_INTERNAL_ERR_MSG'),
messages: err,
autoClose: false
});
},
});
}

Thanks

In postman the url must looks:

like:http://{{CRM_URL}}/sugarcrm/rest/v10/Accounts/mycustomAPI/62aace7c-8729-11eb-a0e4-0e1a95bf95b1

have a issue in the code, are missing one comma after position of "params"

app.api.call('read', app.api.buildURL('Accounts/mycustomAPI/'+model.get('id')), null, {...});

In postman the url must looks:

like:http://{{CRM_URL}}/sugarcrm/rest/v10/Accounts/mycustomAPI/62aace7c-8729-11eb-a0e4-0e1a95bf95b1

have a issue in the code, are missing one comma after position of "params"

app.api.call('read', app.api.buildURL('Accounts/mycustomAPI/'+model.get('id')), null, {...});

From Postman : 

With this URL

http://{{CRM_URL}}/sugarcrm/rest/v10/Accounts/mycustomAPI/62aace7c-8729-11eb-a0e4-0e1a95bf95b1

But with below URL , Response is coming.... 

http://{{CRM_URL}}/sugarcrm/rest/v10/Accounts/mycustomAPI/?id=62aace7c-8729-11eb-a0e4-0e1a95bf95b1

From Browser(Sugar UI)

On click of button : Below Error

 GET18.232.89.200/.../5bb2d56a-b6f9-11eb-a74d-0e1a95bf95b1 404 (Not Found)

registerApiRest()

public function registerApiRest()
{
return array(
//GET
'MyGetEndpoint' => array(
//request type
'reqType' => 'GET',

//set authentication
'noLoginRequired' => false,

//endpoint path
'path' => array('Accounts', 'mycustomAPI', '?'),

//endpoint variables
'pathVars' => array('', '', 'id'),

//method to call
'method' => 'mycustomMethod',

//short help string to be displayed in the help documentation
'shortHelp' => 'get all Cusotmer By Customer ID in SugarCRM',

//long help to be displayed in the help documentation
'longHelp' => '',
)
);
}

public function mycustomMethod($api, $args)
    {
        //custom logic
        return $args;
    }

record.js

app.api.call('read', app.api.buildURL('Accounts/mycustomAPI/' + this.model.get('id')), null,{
 success:function(fdata)
 {
 app.alert.show('Activation-Initiated', {
 level: 'error',
 messages: 'Customer Is Activated',
 autoClose: false
 });
 },
 error: function(error){
 app.alert.show('err', {
 level:'error', 
 messages: 'Customer Is Not Activated',
 autoClose: false
 });
 },
 });

Please suggest the changes.

Thanks.

I tray the code and the results in local instance is:

did you repair the instance after changes?

Thanks alot Sanchez. This really works. I got to learn many things here. Highly Appreciated. 

Issue Solved : Able to call endpoint on click of  button.

Casue Of Error : After all the changes suggested above , i missed to do repair and rebuild.(MY BAD)

<<Question>>

Response of the Endpoint: 

Ok I found out the way to access response.

This is an error when setting the value to field in module.

Error : Uncaught TypeError: Cannot read property 'get' of undefined

Response of the Endpoint: 

Please suggest some changes here.

I understand that you need set a value into current model.
For this task i suggest made this:

var self = this;
app.api.call('read', app.api.buildURL('Accounts/mycustomAPI/' + this.model.get('id')), null,{
success:function(fdata)
{
if (fdata){
console.log("Response", fdata.account_type);
self.model.set('middlename_c', fdata.account_type); // this line set value into current record
console.log("Account Type", middleman);

app.alert.show('Activation-Initiated', {
level: 'success',
messages: 'Customer Is Activated',
autoClose: false
});
}
},
error: function(error){
app.alert.show('err', {
level:'error',
messages: 'Customer Is Not Activated',
autoClose: false
});
},
});

Thanks Sanchez , now am able to set the value into current model. But this value is not saving in database. Once reload ,it revert back to same old value. How to overcome this situation ? 

I think you never click the save action button, therefore this value is never saved in the database.

I don't know the logic in the endpoint function, but, i suggest is better that save this value "middlename_c" there in this function and only return the message notify this action.

$a = BeanFactory::getBean("Accounts", $args['id'], array('disable_row_level_security' => true));
$a->middlename_c = <<Your value>>;
$a->save(false);
return array("code" => 200, "msg" => "Customer Is Activated");