Connect to Canny Data from Blazor Apps

Cameron Leblanc
Cameron Leblanc
Senior Technology Evangelist
Build ASP.NET Core Blazor C# apps that integrate with real-time Canny data using standard SQL.

Blazor is a framework for developing modern, client-side web UIs using .NET technology. Instead of coding in JavaScript, developers can use the familiar C# language and .NET libraries to build app UIs.

The CData API Driver for ADO.NET can be used with standard ADO.NET interfaces, such as LINQ and Entity Framework, to interact with live Canny data. Since Blazor supports .NET Core, developers can use CData ADO.NET Providers in Blazor apps. In this article, we will guide you to build a simple Blazor app that talks to Canny using standard SQL queries.

Install the CData API Driver for ADO.NET

CData ADO.NET Providers allow users to access Canny just like they would access SQL Server, using simple SQL queries.

Install the Canny ADO.NET Data Provider from the CData website or from NuGet. Search NuGet for "Canny ADO.NET Data Provider."

Install ADO.NET Canny Provider from NuGet.

Create a Canny-Connected Blazor App

Start by creating a Blazor project that references the CData API Driver for ADO.NET

  1. Create a Blazor project on Visual Studio.
  2. Create a Blazor app project.
  3. From the Solution Explorer, right click Dependencies, then click Add Project Reference.
  4. In the Reference Manager, click the Browse button, and choose the .dll file of the installed ADO.NET Provider (e.g. System.Data.CData.API.dll, typically located at C:\Program Files\CData\CData API Driver for ADO.NET\lib etstandard2.0).
  5. Reference ADO.NET for Canny .dll in the Blazor app.

SELECT Canny Data from the Blazor App

  1. Open the Index.razor file from the Project page.
  2. In a APIConnection object, set the connection string:

    Start by setting the Profile connection property to the location of the Canny Profile on disk (e.g. C:\profiles\Canny.apip). Next, set the ProfileSettings connection property to the connection string for Canny (see below).

    Canny API Profile Settings

    Canny uses a secret API key to control access to the API. The API key is sent as a JSON body parameter named 'apiKey' in every HTTP POST request to the Canny API endpoints.

    To authenticate with the Canny API, you need your company-level secret API key. You can find this key in your Canny account under Settings > API.

    After setting the following connection properties, you are ready to connect:

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your Canny company-level secret API key from the Settings > API page in your Canny dashboard.

    For example: Profile=C:\profiles\Canny.apip;ProfileSettings='APIKey=your-canny-api-key';

  3. The code below creates a simple Blazor app for displaying Canny data, using standard SQL to query Canny just like SQL Server.

          @page "/"
          @using System.Data;
          @using System.Data.CData.API;
          
          <h1>Hello, world!</h1>
          
          Welcome to your Data app.
          
          <div class="row">
              <div class="col-12">
          
                  @using (APIConnection connection = new APIConnection(
                    "Profile=C:\profiles\Canny.apip;ProfileSettings='APIKey=your-canny-api-key';"))
                  {
                      var sql = "SELECT Id, Name FROM Boards WHERE IsPrivate = 'false'";
                      var results = new DataTable();
          
                      APIDataAdapter dataAdapter = new APIDataAdapter(sql, connection);
                      dataAdapter.Fill(results);
          
                      <table class="table table-bordered">
                          <thead class="thead-light">
                              <tr>
                                  @foreach (DataColumn item in results.Rows[0].Table.Columns)
                                  {
                                      <th scope="col">@item.ColumnName</th>
                                  }
                              </tr>
                          </thead>
                          <tbody>
                              @foreach (DataRow row in results.Rows)
                              {
                                  <tr>
                                      @foreach (var column in row.ItemArray)
                                      {
                                          <td>@column.ToString()</td>
                                      }
                                  </tr>
                              }
                          </tbody>
                      </table>
                  }
              </div>
          </div>
        
  4. Rebuild and run the project. The ADO.NET Provider renders Canny data as an HTML table in the Blazor app. Query Canny from Blazor app.

    At this point, you have a Canny-connected Blazor app, capable of working with live Canny data just like you would work with a SQL Server instance. Download a free, 30-day trial and start working with live Canny data in your Blazor apps today.

Ready to get started?

Connect to live data from Canny with the API Driver

Connect to Canny