Learn more
 

Ready to get started?

Connect to live data from Klipfolio with the API Driver

Connect to Klipfolio

In this article

Related articles

LINQ to Klipfolio Data


LINQ offers versatile querying capabilities within the .NET Framework (v3.0+), offering a straightforward method for programmatic data access through CData ADO.NET Data Providers. In this article, we demonstrate the use of LINQ to retrieve information from the Klipfolio Data Provider.

This article illustrates using LINQ to access tables within the Klipfolio via the CData ADO.NET Data Provider for Klipfolio. 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.

  1. 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.
  2. Choose EF Designer from Database and click Next.
  3. Add a new Data Connection, and change your data source type to "CData Klipfolio Data Source".

  4. Enter your data source connection information.

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

    Klipfolio API Profile Settings

    In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

    Below is a typical connection string:

    Profile=C:\profiles\Klipfolio.apip;ProfileSettings='APIKey=your_api_key';
  5. 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.
  6. 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 datasourcesQuery = from datasources in context.DataSources select datasources; foreach (var result in datasourcesQuery) { Console.WriteLine("{0} {1} ", result.Id, result.Id); }

See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.