LINQ to Short.io Data
This article illustrates using LINQ to access tables within the Short.io via the CData ADO.NET Data Provider for Short.io. To achieve this, we will use LINQ to Entity Framework, which facilitates the generation of connections and can be seamlessly employed with any CData ADO.NET Data Providers to access data through LINQ.
See the help documentation for a guide to setting up an EF 6 project to use the provider.
- In a new project in Visual Studio, right-click on the project and choose to add a new item. Add an ADO.NET Entity Data Model.
- Choose EF Designer from Database and click Next.
- Add a new Data Connection, and change your data source type to "CData Short.io Data Source".
Enter your data source connection information.
Using API Key Authentication
Short.io uses API Key authentication. To obtain your API key:
- Log in to your Short.io account
- Navigate to Settings > Integrations & API > API
- 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';
- If saving your entity connection to App.Config, set an entity name. In this example we are setting APIEntities as our entity connection in App.Config.
- Enter a model name and select any tables or views you would like to include in the model.
Using the entity you created, you can now perform select commands. For example:
APIEntities context = new APIEntities();
var domainsQuery = from domains in context.Domains
select domains;
foreach (var result in domainsQuery) {
Console.WriteLine("{0} {1} ", result.Id, result.);
}
See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.