Connect to Shippo Data from Blazor Apps

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 Shippo 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 Shippo using standard SQL queries.

Install the CData API Driver for ADO.NET

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

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

Create a Shippo-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. From the Solution Explorer, right click Dependencies, then click Add Project Reference.
3. 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).

SELECT Shippo 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 Shippo Profile on disk (e.g. C:\profiles\Shippo.apip). Next, set the ProfileSettings connection property to the connection string for Shippo (see below).

   Shippo API Profile Settings

   In order to authenticate to Shippo, you will need an API Key. You can find this API key under 'Settings' > 'API' > 'Generate Token'. After generating your key, set it to the APIKey in ProfileSettings connection property.

   For example: Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';

3. The code below creates a simple Blazor app for displaying Shippo data, using standard SQL to query Shippo 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\Shippo.apip;ProfileSettings='APIKey=my_api_key';"))
                 {
                     var sql = "SELECT ObjectId , OrderStatus FROM Orders WHERE ShopApp = 'Shippo'";
                     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 Shippo data as an HTML table in the Blazor app.

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