XF 2.2 Problems with API endpoint : users/find-name

[BubbaLovesCheese]

Hi,

I'm having a some problems getting the users/find-name endpoint to work.

I am using postman.co to test the API response.

my URL is https://test.mywebsite.com/api/users/find-name
my key is username
my value is MyUserName
description is What Do I put Here?

Is there something wrong with the syntax?

My error message is:

{
    "errors": [
        {
            "code": "required_input_missing",
            "message": "Required input missing: username",
            "params": {
                "missing": [
                    "username"
                ]
            }
        }
    ]
}

REST API endpoints (2.2)

This document assumes you have already created an API key and setup the necessary headers for your request. Learn more about using the API.

xenforo.com

 

[smozgur]

Nothing looks wrong. I assume your API key is correct, it should work ok. The description field is irrelevant.
Make sure you don't have space in the key text "username". Like "username " or " username".

 

[BubbaLovesCheese]

Interesting, your GET has a parameter I did not include. Is the part after the ? necessary?

 

[smozgur]

Interesting, your GET has a parameter I did not include. Is the part after the ? necessary?

View attachment 238246

No, Postman takes care about forming the url for the GET request.

The problem is obvious now with the screenshot. You are trying to send form body parameters. Clear that and use the Params tab to setup the query parameters.

 

[smozgur]

The problem is obvious now with the screenshot. You are trying to send form body parameters. Clear that and use the Params tab to setup the query parameters.

Refer to my screenshot above.

 

[BubbaLovesCheese]

I gotcha. Thanks. It now works. I should have noticed that.

So an aside question.... Do all GET request require values filled out in the Params section, and POST requests need the valued defined in the Body?

 

[smozgur]

I gotcha. Thanks. It now works. I should have noticed that.

So an aside question.... Do all GET request require values filled out in the Params section, and POST requests need the valued defined in the Body?

Good to hear that.

Yes, you send a form with POST request. Query parameters on the other side, with GET request.