Help me understand Server.callWithPOST

guangcoder

I'm try send a json from Hise to local server (test) but the respond infomation from server is alway status 400 (server is only received blank). I'm newbie, thanks for your help!
Here is example script:

// API Server Connection
// Set the base URL for the Server
Server.setBaseURL("http://localhost:3000/");

// Declare global variables
const emailInput = Content.getComponent("emailInput");
const productKeyInput = Content.getComponent("productKeyInput");
const errorLabel = Content.getComponent("errorLabel");
const pnlGUILock = Content.getComponent("pnlGUILock");
var normalizedResult = ""; // Global variable to help normalize string

// Function to normalize string (remove extra spaces)
inline function normalizeString(input) {
    normalizedResult = ""; // Reset value
    local i = 0;
    while (i < input.length) {
        local char = input.substring(i, i + 1);
        if (char != " " && char != "\t" && char != "\n") {
            normalizedResult = normalizedResult + char;
        }
        i = i + 1;
    }
    return normalizedResult;
}

// Function to display error message
inline function showError(message) {
    errorLabel.set("text", message);
    Console.print("Error: " + message);
}

// Function to check if email is valid
inline function isEmailValid(email) {
    return Server.isEmailAddress(email);
}

// Function to verify license
inline function verifyLicense() {
    // Normalize data from inputs
    local email = normalizeString(emailInput.get("text"));
    local productKey = normalizeString(productKeyInput.get("text"));

    // Check if email is valid
    if (!isEmailValid(email)) {
        showError("Invalid email address!");
        pnlGUILock.showControl(true);
        return;
    }

    // Create payload to send to the server
    local payload = {
        "email": email,
        "productKey": productKey
    };

    Console.print("Sending request with payload: " + JSON.stringify(payload));

    // Call the API to verify license
    Server.callWithPOST("verify-license", payload, function(status, response) {
        Console.print("Response result: Status = " + status);
        Console.print("Server response: " + JSON.stringify(response));

        if (status == 200) {
            if (response.success) {
                showError("License valid! Activation successful.");
                pnlGUILock.showControl(false);
            } else {
                showError("Invalid license!");
                pnlGUILock.showControl(true);
            }
        } else {
            showError("Server connection error! Status: " + status);
            pnlGUILock.showControl(true);
        }
    });
}

// Callback function for the verifyButton
inline function onVerifyButtonControl(component, value) {
    if (value) {
        Console.print("Clicked verifyButton, starting license verification...");
        verifyLicense();
    }
}

// Set callback for the verifyButton
Content.getComponent("verifyButton").setControlCallback(onVerifyButtonControl);


//On server  only received: "Received Body:  {}" when i input email:123456@gmail.com and productKey: abcdefgh123

d.healey

@guangcoder test with hoppscotch to make sure it's not a mistake in the request

guangcoder

@d-healey Thanks Bro for suggestion. Hise seem send text or something different, because server i tested on postman it work. But when try with Hise, it's always report "Status : 400", on server only receive: Empty Body: {}

d.healey

@guangcoder Your normalise function seems a bit janky. Just use myString = myString.replace(" "); and that will remove all spaces.

guangcoder

@d-healey I tried this, but it doesn't work:

inline function normalizeString(input) {
    normalizedResult = normalizedResult.replace(" "); 
    local i = 0;
    while (i < input.length) {
        local char = input.substring(i, i + 1);
        if (char != " " && char != "\t" && char != "\n") {
            normalizedResult = normalizedResult.replace + char;
        }
        i = i + 1;
    }
    return normalizedResult;
}

d.healey

@guangcoder You can delete your normalise function entirely, you don't need it. Use the built in String.replace function.

Lindon

@guangcoder

like this....

inline function verifyLicense() {
    // Normalize data from inputs
    local email = emailInput.get("text").replace(" ");
    local productKey = productKeyInput.get("text").replace(" ");

guangcoder

@d-healey From server, it responded:

Received Body:  {}
Received Body:  {}
Received Body:  {}
Received Body:  {}
Received Body:  {}
Received Body:  {}
Received Body:  {}

It mean server don't understand json which was request by Hise, i check console print on Hise, I saw form was sent something like this: "email": abcd@gmail.com, "productKey": "1234abc", but server don't understand, so, it responded "status: 400"

d.healey

@guangcoder said in Help me understand Server.callWithPOST:

but server don't understand,

What is your endpoint expecting?

guangcoder

@Lindon Thanks Bro, I will try!

guangcoder

@d-healey endpoint is: "verify-license"

Lindon

@guangcoder said in Help me understand Server.callWithPOST:

@d-healey endpoint is: "verify-license"

and the API for this call is what?

guangcoder

@Lindon I test on local server: http://localhost:3000/

d.healey

@guangcoder said in Help me understand Server.callWithPOST:

@d-healey endpoint is: "verify-license"

But what data is it expecting?

guangcoder

@d-healey said in Help me understand Server.callWithPOST:

But what data is it expecting?

My perpose is create a simple protection through API system, ask users Login with email and product key, then click verify, on server.js it insert available nfo (input by users). If match, set unlock GUI from Hise

d.healey

@guangcoder But what data is the endpoint expecting you to send to it?

guangcoder

@d-healey said in Help me understand Server.callWithPOST:

what data is the endpoint expecting you to send to it?
Here is the way i apply Server.callWithPOST

Server.callWithPOST("verify-license", payload, function(status, response) {
   
});

payload = email & product key

d.healey

@guangcoder Do you have some documentation for the end point you are calling that I can look at?

guangcoder

@d-healey said in Help me understand Server.callWithPOST:

Do you have some documentation for the end point you are calling that I can look at?

Yes, sure:

Verify License Endpoint

URL: /verify-license
Method: POST
Description: This endpoint receives a POST request with user data (email, product key, and system ID) and verifies the license validity. It returns the result indicating whether the license is valid.

Request Payload

The payload sent to the server must be in JSON format and include the following fields:
Example Payload:

{
  "email": "user@example.com",
  "productKey": "XYZ123456",
}

Sure! Here's a concise English translation of the documentation:

Verify License Endpoint
URL: /verify-license
Method: POST
Description: This endpoint receives a POST request with user data (email, product key, and system ID) and verifies the license validity. It returns the result indicating whether the license is valid.
Request Payload
The payload sent to the server must be in JSON format and include the following fields:

Field Type Description
email string User's email address.
productKey string User's product key.
system_id string User's unique system identifier.
Example Payload:

{
  "email": "user@example.com",
  "productKey": "XYZ123456",
  "system_id": "SYSTEM_ID_1234"
}

3. Response
- Successful Response:

{
"success": true,
"message": "License valid! Activation successful."
}

- Unsuccessful Response:
{
  "success": false,
  "message": "License invalid!"
}

HTTP Status Codes

200 OK: Success. The success field in the response is true.
400 Bad Request: Invalid request (e.g., missing or incorrect data).
500 Internal Server Error: Server error (e.g., system or database issues).

Sure! Here's a concise English translation of the documentation:

Verify License Endpoint
URL: /verify-license
Method: POST
Description: This endpoint receives a POST request with user data (email, product key, and system ID) and verifies the license validity. It returns the result indicating whether the license is valid.
Request Payload
The payload sent to the server must be in JSON format and include the following fields:

Field Type Description
email string User's email address.
productKey string User's product key.
system_id string User's unique system identifier.
Example Payload:

{
  "email": "user@example.com",
  "productKey": "XYZ123456",
}

Response
The server will return a JSON object with the following fields:

Field Type Description
success boolean true if the license is valid, false if not.
message string A detailed message about the verification result.
Successful Response:
{
"success": true,
"message": "License valid! Activation successful."
}
Unsuccessful Response:


{
  "success": false,
  "message": "License invalid!"
}

HTTP Status Codes

200 OK: Success. The success field in the response is true.
400 Bad Request: Invalid request (e.g., missing or incorrect data).
500 Internal Server Error: Server error (e.g., system or database issues).

Example API Call

var payload = {
    "email": "user@example.com",
    "productKey": "XYZ123456",
};

Server.callWithPOST("verify-license", payload, function(status, response) {
if (status == 200) {
if (response.success) {
Console.print("License valid! Activation successful.");
} else {
Console.print("License invalid!");
}
} else {
Console.print("Server connection error! Status: " + status);
}
});

Error Handling
When the server encounters an issue, it will return an error status and a detailed message, such as:

400: Invalid data.
500: Server error.

d.healey

This looks like ChatGPT output? Do you have a link to the original documentation?

Help me understand Server.callWithPOST

14

1.7k

11.8k

102.4k