Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
  2. Welcome
    1. Getting started
    2. Get Flexmonster
    3. Quick start
    4. System requirements
    5. Troubleshooting
    6. Managing license keys
    7. Migrating from WebDataRocks to Flexmonster
  3. Integration with frameworks
    1. Available tutorials
    2. Integration with Angular
    3. Integration with React
    4. Integration with Vue
    5. Other integrations
      1. Integration with Python
        1. Integration with Django
        2. Integration with Jupyter Notebook
      2. Integration with React Native
      3. Integration with AngularJS (v1.x)
      4. Integration with TypeScript
      5. Integration with R Shiny
      6. Integration with jQuery
      7. Integration with Ionic
      8. Integration with Electron.js
      9. Integration with Webpack
      10. Integration with RequireJS
  4. Connecting to Data Source
    1. Supported data sources
    2. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    4. Database
      1. Connecting to SQL databases
      2. Connecting to a MySQL database
      3. Connecting to a Microsoft SQL Server database
      4. Connecting to a PostgreSQL database
      5. Connecting to an Oracle database
    5. Flexmonster Data Server
      1. Getting started with Flexmonster Data Server
      2. Installation guide
      3. Configurations reference
      4. Data sources guide
      5. Security and authorization guide
      6. The Data Server as a DLL
        1. Getting started with the Data Server as a DLL
        2. Referring the Data Server as a DLL
        3. Implementing the API controller
        4. Implementing the server filter
        5. Implementing the custom parser
        6. DLL configurations reference
        7. The controller's methods for request handling
      7. Troubleshooting the Data Server
    6. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
    7. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Flexmonster Accelerator
      3. Referring the Accelerator as a DLL
      4. Configuring the authentication process
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    8. Custom data source API
      1. Introduction to the custom data source API
      2. A quick overview of a sample Node.js server
      3. A quick overview of a sample .NET Core server
      4. Implement your own server
        1. Implementing the custom data source API server
        2. Implementing filters
        3. Supporting more aggregation functions
        4. Supporting multilevel hierarchies
        5. Returning data for the drill-through view
    9. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    10. Pentaho Mondrian
      1. Connecting to Pentaho Mondrian
      2. Getting started with the Accelerator
      3. Configuring Mondrian roles
      4. Configuring username/password protection
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    11. Connecting to other data sources
  5. Security
    1. Security in Flexmonster
    2. Security aspects of connecting to an OLAP cube
      1. Ways of connecting to an OLAP cube
      2. The data transfer process
      3. Data security
      4. Data access management
  6. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Mapping
    6. Number formatting
    7. Conditional formatting
    8. Set the report for the component
    9. Get the report from the component
    10. Date and time formatting
    11. Configuring global options
    12. Export and print
    13. Calculated values
    14. Custom sorting
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with amCharts
    5. Integration with Google Charts
    6. Integration with FusionCharts
    7. Integration with any charting library
  8. Customizing
    1. Available tutorials
    2. Customizing the Toolbar
    3. Customizing appearance
    4. Customizing the context menu
    5. Customizing the grid
    6. Customizing the pivot charts
    7. Localizing the component
  9. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.7 to 2.8
    4. Migration guide from 2.6 to 2.7
    5. Migration guide from 2.5 to 2.6
    6. Migration guide from 2.4 to 2.5
    7. Migration guide from 2.3 to 2.4
    8. Migration guide from 2.2 to 2.3
  10. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  11. Documentation for older versions
Table of contents

Implementing the API controller

The API controller is essential for the communication of the server and Flexmonster Pivot. This guide describes how to implement the API controller for Flexmonster.DataServer.Core.dll.

This tutorial relates to the guide Referring the Data Server as a DLL and should be completed as a part of it.

Step 1. Create a new API controller

If needed, create the Controllers folder inside the project:

Then create a new API controller class FlexmonsterAPIController inside this folder:

The code should be the following:

[Route("api")]
[ApiController]
public class FlexmonsterAPIController : ControllerBase
{
}

Step 2. Include Flexmonster.DataServer.Core in the controller

To use the DLL in the controller, add the following line of code to the beginning of the FlexmonsterAPIController.cs file:

using Flexmonster.DataServer.Core;

Step 3. Add the IApiService field to the controller

IApiService is a class from Flexmonster.DataServer.Core.dll containing methods for handling the custom data source API requests. These methods allow getting fields, members, and aggregated data.

To use the methods, add the field of the IApiService type to the controller class:

private readonly IApiService _flexmonsterApiService;

public FlexmonsterAPIController(IApiService apiService)
{
_flexmonsterApiService = apiService;
}

Then, four POST requests should be handled: /handshake, /fields, /members, and /select.

Step 4. Include Flexmonster.DataServer.Core.Models to the controller

The Flexmonster.DataServer.Core.Models class contains type definitions for requests and responses. To include it to the controller, add the following line of code to the beginning of the FlexmonsterAPIController.cs file:

using Flexmonster.DataServer.Core.Models;

Step 5. (optional) Handle the /handshake request

This step is optional as it describes the handling of a /handshake request, which is also optional. Even if the server does not handle it, Flexmonster Pivot will proceed to the next request.

The /handshake request establishes a connection between the client and server sides. If the server sends the implemented version of the custom data source API in response to the /handshake request, the client can check whether the server and the client implement the same version of the custom data source API.

To receive notifications about the version compatibility, respond to the /handshake request with the implemented version of the custom data source API:

const string API_VERSION = "2.8.5";

[Route("handshake")]
[HttpPost]
public IActionResult Handshake()
{
object response = new { version = API_VERSION };
return new JsonResult(response);
}

Step 6. Handle the /fields request

The first required request to handle is the /fields request. To handle it, use the GetFields() method of the IApiService class:

[Route("fields")]
[HttpPost]
public IActionResult PostFields([FromBody]FieldsRequest request)
{
var response = _flexmonsterApiService.GetFields(request);
return new JsonResult(response);
}

FieldsRequest is a predefined class from Flexmonster.DataServer.Core.Models. It describes the /fields request’s structure.

Step 7. Handle the /members request

The next required request to handle is the /members request. Handle it with the GetMembers() method of the IApiService class. It should be done as follows:

[Route("members")]
[HttpPost]
public IActionResult PostMembers([FromBody]MembersRequest request)
{
var response = _flexmonsterApiService.GetMembers(request);
return new JsonResult(response);
}

MembersRequest is a predefined class from Flexmonster.DataServer.Core.Models. It describes the /members request’s structure.

Step 8. Handle the /select request

One more request that should be handled is the /select request. To handle it, use the GetAggregatedData() method of the IApiService class:

[Route("select")]
[HttpPost]
public IActionResult PostSelect([FromBody]SelectRequest request)
{
var response = _flexmonsterApiService.GetAggregatedData(request);
return new JsonResult(response);
}

SelectRequest is a predefined class from Flexmonster.DataServer.Core.Models. It describes the /select request’s structure.

After handling all the requests, the controller is ready for usage. Now you can return to the Referring Flexmonster Data Server as a DLL guide and complete it.

What’s next?

You may be interested in the following articles: