VOOZH about

URL: https://www.cdata.com/kb/tech/shortio-ado-linqpad.rst

โ‡ฑ Working with Short.io Data in LINQPad


Working with Short.io Data in LINQPad

๐Ÿ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Execute LINQ queries to Short.io data in LINQPad.

The CData ADO.NET Provider for Short.io enables you to use standard ADO.NET interfaces like LINQ and the Entity Framework to work with Short.io data. This article will demonstrate the process of establishing a connection from LINQPad and executing LINQ queries.

Create the Data Model

After downloading and installing both the provider and LINQPad, create a new class library project within Visual Studio.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

  1. Right-click your project and click Add -> New Item -> ADO.NET Entity Data Model. In the resulting dialog, select Code First from database. Click New Connection and specify the connection string options in the resulting wizard.

    Using API Key Authentication

    Short.io uses API Key authentication. To obtain your API key:

    1. Log in to your Short.io account
    2. Navigate to Settings > Integrations & API > API
    3. Click Create API Key and copy your API key

    After obtaining the API key, you are ready to connect:

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your Short.io API key obtained from Settings > Integrations & API > API.

    Example connection string:

    Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
    

    Available Tables

    The Short.io profile provides access to the following tables:

    • Domains - Short.io domains associated with the authenticated account
    • Links - Short links for a domain
    • LinkExpand - Expand a short link by domain and path
    • LinksByOriginalUrl - Retrieve multiple short links matching a given original destination URL
    • Folders - Link folders within a specific domain
    • LinkPermissions - Permission records for a specific link within a domain
    • CountryTargeting - Country-based redirect targeting rules for a specific short link
    • RegionTargeting - Region-based redirect targeting rules for a specific short link
    • Regions - List of available regions/states for a given country code
    • DomainStatistics - Aggregated click and traffic statistics for a Short.io domain
    • LinkStatistics - Aggregated click and traffic statistics for a specific Short.io link

    Below is a typical connection string:

    Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
    ๐Ÿ‘ The required connection properties in the Entity Data Model Configuration Wizard. (JSON is shown.)
  2. Select the desired tables and views and click Finish to create the data model.

    ๐Ÿ‘ The last step of the Entity Data Model Configuration Wizard, where tables are imported into the entity model.
  3. Build the project. The generated files can be used to create the Short.io connection in LINQPad.

Connect to Short.io Data in LINQPad

After you have obtained the required connection properties and created the data model assembly, follow the steps below to start using the data model in LINQPad.

  1. Open LINQPad and click Add Connection.

  2. Select the "Use a typed data context from your own assembly" option.

  3. Select Entity Framework DbContext.

    ๐Ÿ‘ The Choose Data Context dialog.
  4. Click Browse next to the Path to Custom Assembly box and browse to your project folder. Browse to the .dll or .exe under the bin folder.

  5. Select the name of the DbContext.
  6. If you saved your connection string in App.Config, specify the path to the App.config.
๐Ÿ‘ The next step of the wizard, where the data model assembly is imported.

You can now query Short.io data through LINQPad. For examples of the supported LINQ queries, see the "LINQ and Entity Framework" chapter in the help documentation.

๐Ÿ‘ The results of a query in LINQPad. (JSON is shown.)