Creating custom Endpoints Suitecrm Rest API v8

💬 General Discussion
1

Hello,

I have spent lots of time but did’t find good documentation to create custom endpoints in REST API V8.

I have check below documentation but its confusing .

https://docs.suitecrm.com/developer/api/version-8/customization/

Anyone please suggest good demo example for demo link

Thanks

2

@rigal did you able to create an custom api in SuiteCRM8. I’m facing the same issue because the documentation is very confusing

3

I found this one, it helped me, I hope for you the same.

4

This URL is not available anymore. Does anyone find some more documentation about this topic, because this (Customization :: SuiteCRM Documentation) is not working.

5

Where are you putting your customisations is it
custom/application/Ext/Api/V8 … Folder
Or
custom/Extension/application/Ext/Api/V8… Folder

Because the first one is the correct location

6

Thanks for your fast response.

My path (custom/application/Ext/Api/V8/Config/routes.php) is correct. I created the file routes.php and added the basic example code:

<?php
$app->get('/hello', function() {
    return 'Hello World!';
});

I did a ‘quick and repair’ and tried to go to the url: {suitecrm}/Api/hello, but still got the 404 (not found) error.

7

Your url will be {suitecrm}/Api/V8/custom/hello

1 Like
8

Thank you for your help, it works! Unfortunately this was not in the documentation.

9

Just one more question.

I want to get this endpoint without any authentication, so no need to have a access_token to GET/POST some data. Is it possible to disable the authentication for this specific endpoint, because I still get the error 401 (Unauthorized)?

10

Of the top of my head i don’t know how to disable authorization
But a simpler way (if you are not using any specific api functionality) to do what you want is to make an entrypoint (not an api endpoint) with authorization false

11

Thank you, but this is not what I want.

I have a external JavaScript front-end application (Vue.js) where customers can sign in and see there own projects and user details. So I am using the endpoints from SuiteCRM to show their data.

There is just one tiny problem. Because if they forgot their password, there must be the ability to reset their password with a “forgot password?” button. Sounds easy right? create a select-field with “user forgot password”. Then create a workflow in SuiteCRM that if the User-module changed, and the “user forgot password” is select, send an e-mail to the user and set the user_forgot_password back to false . But it is not possible to update a record while the user is not logged in, because they don’t have an access_token. So I wanted to create an endpoint "/Api/V8/custom/reset_password={user_name} and then trigger a method to update the record with the value: user_forgot_password = true.

Now you know my case, maybe there is a better solution. But I thought creating my own endpoint without authentication would be the best solution.

12

I also integrated a xamarin app with suitecrm through the api

For resetting password there is already a build in entrypoint “GeneratePassword” in the crn

13

Do you have an example. I also have Xamarin Experience, so that’s not a problem.

But you use the EntryPoint to “GeneratePassword” without an “access_token”. You can reach this EntryPoint without any authentication?

14

Actually that’s the same entrypoint (not an api endpoint) that crm ui uses to reset a users password. It obeys the password and reset settings set in password manager

        {
            var reply="";
            Uri uri = new Uri(string.Format(CRMUrls.baseCRMUrl, string.Empty));
            //var MyDynamic = new loginObject();
            //MyDynamic.grant_type = "password";
            //MyDynamic.client_id = CRMUrls.client_id;
            //MyDynamic.client_secret = CRMUrls.client_secret;
            //MyDynamic.username = username;
            //MyDynamic.password = password;

            //string json = JsonConvert.SerializeObject(MyDynamic);

            MultipartFormDataContent content = new MultipartFormDataContent();
            content.Add(new StringContent("GeneratePassword"), "entryPoint");
            content.Add(new StringContent(username), "user_name");
            content.Add(new StringContent(email), "user_email");
            content.Add(new StringContent("1"), "link");
            try
            {
                var response = await client.PostAsync(uri, content);

                if (response.IsSuccessStatusCode)
                {
                    string resp = await response.Content.ReadAsStringAsync();
                    reply = resp;
                    if (resp == "1")
                    {
                        return resp;
                    }
                }
            }
            catch (Exception e1)
            {
            }
            return reply;

        }  ```
15

Okay, I get it. You call the URL: {suitecrm}/index.php?entryPoint=GeneratePassword&user_name=xxx&user_email=xxx. Or am I wrong?

16

I think this is supposed to be a post call

17

Sorry, I was trying that, but I think I miss just something in my body.

Screenshot 2022-10-15 at 11.29.27
Screenshot 2022-10-15 at 11.29.271708×926 95.2 KB

18

The body is not raw it either form or x-www-urlen coded

19

Also tried form-data and x-www-form-urlencoded, but still the same response.

20

Add this link => 1 parameter as well