Invalid Parameter : Custom Endpoint

RE: Invalid Parameter : Custom Endpoint

Rajnikanth BS — Thu, 10 Jun 2021 14:45:07 GMT

Hi Vamshi S

Below is my XML headers and JSON request for custom module (order) and Stock module(accounts)

Request Body update order :

{
  "o_id": "54",
  "custAccount": "C60"
}

XML Headers update order :

<propertyMap>
<property>
<name>Request-Line</name>
<value>PUT /sugarcrm/rest/v10/Ord_Orders/UpdateOrderMethod HTTP/1.1</value>
</property>
<property>
<name>Cookie</name>
<value>PHPSESSID=aec8062hn4rq7b7797ov5aqp2s; path=/</value>
</property>
<property>
<name>Authorization</name>
<value>Bearer 9babc467-f6ab-41ad-80ca-8c7ef5d28c59</value>
</property>
<property>
<name>Accept</name>
<value>application/json</value>
</property>
<property>
<name>Host</name>
<value>ip address comes here</value>
</property>
<property>
<name>Content-Type</name>
<value>application/json; charset=ISO-8859-1</value>
</property>
</propertyMap>

Request Body for accounts :

{ "name": "Customer Account07", "account_type": "Customer Account", "phone_office": "12345678", "email": "abc@xyz.com", "salutation_c": "Ms.", "username_c": "Abc", "lastname_c": "Xyz", "active_cart_id_c": "123456", "bel_customer_id_c": "543678" }

XML headers for accounts :

<propertyMap> <property> <name>Request-Line</name> <value>POST /sugarcrm/rest/v10/Accounts HTTP/1.1</value> </property> <property> <name>Cookie</name> <value>PHPSESSID=bmc7frtmkq70c957gkm1v2v4sl; path=/</value> </property> <property> <name>Authorization</name> <value>Bearer e215b865-2d52-4cc3-ab22-2c620f33b55e</value> </property> <property> <name>Accept</name> <value>application/json</value> </property> <property> <name>Host</name> <value>ip address here</value> </property> <property> <name>Content-Type</name> <value>application/json; charset=ISO-8859-1</value> </property> </propertyMap>

RE: Invalid Parameter : Custom Endpoint

Vamshi S — Thu, 10 Jun 2021 04:18:05 GMT

In such case,

Since the Custom API is working fine in Postman it should work fine in your application also. It is clear that there is no issue with the Custom API you have written in Sugar.

The error code 422 will only thrown when you miss some parameters in API or there may some syntax error in the request body.

It would be more helpful to understand the issue if you share the XML of you request with request body. Also share the XML with request body you have given for POST /Accounts (Stock API). It would more easier to debug by comparing the stock and custom APIs.

Thank You,
Vamshi S.

RE: Invalid Parameter : Custom Endpoint

Rajnikanth BS — Wed, 09 Jun 2021 14:34:03 GMT

Hi Vamshi S,

I tried stock API's from the external application which are working fine without any issues. For me this problem is only for custom API's.

RE: Invalid Parameter : Custom Endpoint

Vamshi S — Wed, 09 Jun 2021 14:29:14 GMT

Hi Rajinikanth,

From the whole thread It seems that you will feed all the API parameters like URL, headers, cookies etc in XML format to your external application and the application will parse the XML and call the API Endpoint.

If so,

The issue may because of your external application is failing to call POST API requests. Can you once try calling the Sugar's stock API for creating an Accounts "POST /Accounts" with some request body.

You can use the below link as reference
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_11.0/Integration/Web_Services/REST_API/Endpoints/module_POST/

By this you may get some clue about the issue.

RE: Invalid Parameter : Custom Endpoint

Rajnikanth BS — Tue, 01 Jun 2021 12:25:07 GMT

Francesca Shiekh

We had debugged one more thing ie., the headers are hitting sugarCRM has XML but the request parameters are passing as JSON for same API.

There is no logs inside php, mysql, apache and sugarCRM.

RE: Invalid Parameter : Custom Endpoint

Francesca Shiekh — Tue, 01 Jun 2021 11:57:16 GMT

Sorry, it's really hard to immagine what might be going on, since you say it works through Postman.

I would start by looking at all the logs: php, sugar, console to see if you can see anything.

RE: Invalid Parameter : Custom Endpoint

Rajnikanth BS — Tue, 01 Jun 2021 06:40:57 GMT

Francesca Shiekh
We had changed the v10 to v11 in the API : http://{{URL}}/sugarcrm/rest/v11/Ord_Orders/UpdateOrderMethod but still we are getting the same error.

Is there any way that we can debug here before it hit the entrypoint . Either the request and headers are proper.
http://{{URL}}/sugarcrm/rest/v10/Ord_Orders/UpdateOrderMethod

RE: Invalid Parameter : Custom Endpoint

Francesca Shiekh — Thu, 27 May 2021 22:44:44 GMT

So, I may be totally off base, but I looked at some API documentation, if I read it right Bearer Token support was added in v11

https://sugarclub.sugarcrm.com/dev-club/b/dev-blog/posts/the-sugar-rest-api-adds-support-for-oauth-2-0-bearer-tokens-in-fall-18

which would mean that, assuming you are not many years behind on your version, if you just change your http from

http://{{URL}}/sugarcrm/rest/v10/Ord_Orders/UpdateOrderMethod

http://{{URL}}/sugarcrm/rest/v11/Ord_Orders/UpdateOrderMethod

It might work?

I admit I don't have a full understanding of the API Authentication processes... so again, I'll defer to someone else.

sugarclub.sugarcrm.com/.../api-authentication-primer

RE: Invalid Parameter : Custom Endpoint

Francesca Shiekh — Thu, 27 May 2021 22:27:48 GMT

Sorry Rajnikanth BS,

I can't see what the problem is other that v10 being superseded by rest v11 in more recent versions, but I don't see why that would break it. Maybe André will have more insight for you.

RE: Invalid Parameter : Custom Endpoint

Rajnikanth BS — Thu, 27 May 2021 06:14:32 GMT

Hi Francesca Shiekh,

Thank you for the reply.

Curl isn't used to call API. Javascript is used to call API in the other server. Below is the procedure used to call the API
All the sugarCRM inbuilt stock API's are working properly. with the other server. Only custom module's API is not working.

Once the access token is generated from below url :
http://{{URL}}/sugarcrm/rest/v10/oauth2/token (token is generated from this url)

will be passed in the headers as Bearer token to update orderAPI
http://{{URL}}/sugarcrm/rest/v10/Ord_Orders/UpdateOrderMethod

<propertyMap>
<property>
<name>Request-Line</name>
<value>PUT /sugarcrm/rest/v10/Ord_Orders/UpdateOrderMethod HTTP/1.1</value>
</property>
<property>
<name>Cookie</name>
<value>PHPSESSID=6b1c70d0-6571-4969-b613-6697b2a2311a; download_token_custom=d6794d5a-e532-44f8-b655-15efcb2b893e</value>
</property>
<property>
<name>Cookie</name>
<value>PHPSESSID=lncpj8nrnjqdutfuh205vao8rr; path=/</value>
</property>
<property>
<name>Authorization</name>
<value>Bearer 6b1c70d0-6571-4969-b613-6697b2a2311a</value>
</property>
<property>
<name>Accept</name>
<value>*/*</value>
</property>
<property>
<name>Host</name>
<value>{{Value is been added has IP}}</value>
</property>
<property>
<name>Content-Type</name>
<value>application/json; charset=ISO-8859-1</value>
</property>
</propertyMap>

RE: Invalid Parameter : Custom Endpoint

Rajnikanth BS — Thu, 27 May 2021 05:35:56 GMT

Hi André Lopes,

Thank you for your reply.
Below is my url and registerApiRest method

URL : http://{{URL}}/sugarcrm/rest/v10/Ord_Orders/UpdateOrderMethod

Method :

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

                //set authentication
                'noLoginRequired' => false,

                //endpoint path
                'path' => array('Ord_Orders','UpdateOrderMethod'),

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

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

                //short help string to be displayed in the help documentation
                'shortHelp' => 'updating an order in SugarCRM',

                //long help to be displayed in the help documentation
                'longHelp' => './custom/modules/Ord_Orders/clients/base/api/help/CreateOrder.html',
            ),
        );
    }

RE: Invalid Parameter : Custom Endpoint

Francesca Shiekh — Thu, 27 May 2021 00:04:15 GMT

If your call works in Postman but not from your other server I would check whether you are passing authentication correctly.

Are you using curl and passing your OAuth token as a parameter instead of adding it to the header?

curl_setopt($curl_request, CURLOPT_HTTPHEADER, array("Content-Type: application/json", "oauth-token: {$oauthtoken}"))

RE: Invalid Parameter : Custom Endpoint

André Lopes — Wed, 26 May 2021 15:02:42 GMT

Can you share the content of method registerApiRest for that custom api? Also you can share the url external api is calling?

Regards