The API Request Block allows you to make API calls within a dataflow. You can configure it by specifying the HTTP method, API endpoint, headers, query, body, and path parameters. The methods supported are GET, POST, PUT, DELETE, and PATCH.

You can use the API Request Block to invoke the private APIs. When you use this block, ensure that you use the endpoints https://{host_name}/das/getUserDetails.

Example Scenario

Requirement
Consider a scenario where, during the creation of a dataflow, you need to retrieve customer details using the Get Customer Details API.

Solution
You can add an API Request Block with the following details.

• Method: GET
• URL: https://{host}/v2/customers/lookup/customerDetails
• Query Parameters:
  • Key: embed
  • Value: points, mlp

Configuring the API Request Block

To configure the API Request block, perform the following:

1. From the dataflow canvas, click on the connector.
2. Select the API Request block from the pop-up window.
3. In the Block name section, enter the block name.
   Note: Block names cannot contain spaces or special characters, except for underscores (_). Use camelCase or snake_case formatting.
4. In the Method section, select a method from the drop-down menu. The available methods are GET, POST, PUT, DELETE, and PATCH.
5. In the URL section, enter the API URL.
   Syntax: https://{host}/{URL} Example: https://{host}/v2/customers/lookup/customerDetails
6. In the Query Parameters section, enter the key and its corresponding value. The entries into the Key and the Value fields depend on the API parameters.
   Example: For the API endpoint https://{host}/v2/customers/lookup/customerDetails, some of the query parameters are source, embed, and identifierName. The query parameters are set as Key, and their corresponding values are provided as Value. Consider the parameter embed. Some possible values for embed are points, subscriptions, and mlp. So, if the Key is embed, the Value can be points, subscriptions, or mlp.
7. If applicable, in the Path Parameters section, enter the Key and its corresponding Value . The entries into the Key and the Value fields depend on the API parameters.
   Example: For the API endpoint, https://{host}/api_gateway/loyalty/v1/programs/{programs}/promotions/{promotions}/get, the path parameters are program and promotion. Here, program and promotion are set as Key, and their respective values should be provided in the Value section.
8. If applicable, in the Headers section, enter the Key and its corresponding Value. For more information on headers, see Header Management in Neo.
9. Configure the input execution logic, cachable feature, and define the execution path as per the requirement.
10. Click Done.

Header Management in Neo

Request headers are key-value pairs in an HTTP request that provide essential information about the request context. They help the server understand how to process the request and respond appropriately.

Below is a list of headers available in Neo. Additionally, you can create custom headers according to your requirements.

Handling Bulk API Call Errors

When Neo executes multiple APIs in a single request, it handles the error as follows:

• If any individual call fails, the respective API Request Block's response displays "msg": "failed" .
• Neo continues executing the remaining calls and collects all responses, including the successful ones.

Below is a sample response when Neo executes multiple APIs in a single request.

{
  "api1Output": "1234fjefenjkrfknj4rvjkn",
  "api2Output": {
    "code": 500,
    "message": "{\"code\":500,\"message\":\"UNKNOWN EXCEPTION\",\"err\":\"TypeError: Cannot set properties of undefined (setting 'x-cap-neo-error-msg')\"}",
    "err": {
      "message": "{\"code\":500,\"message\":\"UNKNOWN EXCEPTION\",\"err\":\"TypeError: Cannot set properties of undefined (setting 'x-cap-neo-error-msg')\"}"
    }
  },
  "api3Output": "1234fjefenjkrfknj4rvjkn",
  "msg": "failed"
}

Explanation

• api1Output, api2Output, and api3Output are the names of the individual API calls.
• api1Output and api3Output contains successful responses.
• api2Output contains a 500 error response with detailed metadata.

The msg field shows the overall status. It reads "failed" because api2Output failed.

Using Private APIs

You can use the API Request block to invoke private APIs. To use the output in subsequent blocks, add a Script block after the API Request block and use the DAO function getOut() to retrieve the response.

Example use case

Requirement
Retrieve a customer's expired points using the private API getExpiredPointsByCustomerIdAndYear, and transform the data into a cleaned-up, format with only the fields customerId, year, earned, and expired from the output, which is in an array format.

Solution
Add a Script block after the API Request block. Use the DAO function getOut() to extract the output from the API Request block, then transform the array into the required summarised format.

Below is a sample script from the Script block to achieve the same.

import dao from "neo/dao";
import logger from "neo/logger";
//These are some dao methods already imported.
//Other methods on dao you can use by typing `dao.` and editor will suggest few available methods.
const {
    getBody,
    getEffectiveHeaders,
    getIn,
    getApiRequest,
    getOut,
} = dao;




const script = {


    execute: () => {
      var payload = dao.getOut();
      logger.info("test"+JSON.stringify(payload));
      //return payload;
      //logger.info(JSON.stringify(payload, null, 2));
        //Write your code here.
      const result =  transformPointsData(payload);
      logger.info(JSON.stringify(result, null, 2));
      return {
              "http": {
                   "res": {
                       "json": result,
                       "status": 200
                   }
               }
 }
    }
}


/**
 * Transforms an array of point-earning records into a summarized format.
 *
 * @param {Array<Object>} inputData The array of original point records.
 * @returns {Array<Object>} The array of transformed objects.
 */
function transformPointsData(inputData) {
  // Get the current year to compare against the creation year.
  const currentYear = new Date().getFullYear();


  // Use the map function to iterate over each item and transform it.
  return inputData.map(item => {
    // Create a Date object from the timestamp (which is in milliseconds).
    const createdDate = new Date(item.created_on);
    const createdYear = createdDate.getFullYear();


    // Determine the value for 'expired'. If the points were earned in the
    // current year, 0 points have expired. Otherwise, all earned points
    // are considered expired for this transformation.
    const expiredPoints = (currentYear === createdYear) ? 0 : item.earned;


    // Return the new object with the desired structure and keys.
    return {
      customerId: item.customer_id, // Renaming 'customer_id' to 'customerId'
      year: createdYear,
      earned: item.earned,
      expired: expiredPoints
    };
  });
}


export {
    script as default
}