OData REST API for SQL Server

December 11, 2019

Skyvia Team

With Skyvia you do not need to build web API manually — no need in developing a service, caring about security, hosting and domain, obtaining respective certificates, deploying, administering or maintaining. Skyvia Connect is a universal cloud-based solution that takes care of all this. It needs no coding, no technical skills.

Skyvia Connect allows you to easily expose your SQL Server data via OData service — RESTful API for quick, real-time data access and manipulation. OData is a widely accepted open standard built on HTTP, ATOM/XML and JSON, intended for data access over the Internet with no firewall configuration. You can use it to expose any kind of data in a fast and convenient way – both from cloud and on-premise servers. To connect to on-premise servers, use our new Agent application developed by Skyvia team exactly for these needs.

Table Of Contents

  1. What Is Agent? How Can We Configure It?
  2. Creating an Agent in Skyvia
  3. Creating a Connection in Skyvia
  4. Creating an Endpoint in Skyvia
  5. Supported Versions of Microsoft SQL Server

What Is Agent? How Can We Configure It?

Agent is a secure tunnel application developed to connect your Skyvia account to local, on-premise databases with ease and comfort and to establish secure communication bypassing firewall.

Try its functions by installing Agent application to your PC and creating a SQL Server connection you want to work with. Follow our easy step-by-step tutorial on how to do it in Skyvia.

Build fully automated data pipelines in minutes
Integrate data between 80+ cloud sources with no coding with Skyvia Data Integration

Creating an Agent in Skyvia

To start, first you need to create a free account in Skyvia. Second, you need to proceed with creating an agent. We've tried to provide the detailed instruction on how to do it.

To create an agent, perform the following steps:

  1. Click +NEW in the top menu and select Agent from the list on the left.

    Agent icon

  2. When the Agent editor page opens, click Download.exe to download an Agent application

    Skyvia Agent for Windows

  3. Click the downloaded file to install the Agent application.
  4. When you do it, the Skyvia Agent window pops up. Click the INSTALL button. By default, agent will be installed to C:\Program Files (x86)\Skyvia Agent.

    Install Agent window

  5. After you have downloaded the Skyvia agent, you need to download the security key. To do it, click Download Key at the top right corner.
  6. When the key file is downloaded to the Downloads folder, move it to the folder where the Agent is installed. Note that the key file name should always be skyvia_security_agent.key.
  7. Then, in the Skyvia Agent folder, click Skyvia.Agent.Client to start the program.
  8. If you have done everything correctly, on the Agent editor page you will see Connected sign and green light next to it.

    Connected Sign

  9. Optionally test the agent connection by clicking the Test agent button.

Creating a Connection in Skyvia

To create a connection, perform the following steps:

  1. Click +NEW in the top menu.
  2. Select Connection from the list on the left. The Select Connector page will open.

    Select Connector Page

  3. Select SQL Server from available connections.
  4. When the Connection editor page opens, select Agent under Connection Mode and fill in all the required parameters.

    SQL Server Connection

  5. Click Test Connection to check whether the connection is successful. Then click Create Connection to create and save the connection.

Create OData endpoint in a few clicks
Get a free plan to publish your database or cloud data via OData without coding

Creating an Endpoint in Skyvia

To create an SQL server OData endpoint, perform the following steps:

  1. Click +NEW in the top menu and click on Endpoint under Connect.

    Endpoint button

  2. On the page that opens, select the SQL Server connection from the created ones and you are transferred to the Endpoint editor page.

  3. On the Endpoint editor page, drag-n-drop tables you need and manage connections between them.

    Endpoint window

  4. In Skyvia, you can optionally allow only authenticated users to access endpoint data and optionally limit IP addresses, from which the data of the endpoint can be accessed. Click Users on the toolbar and add a user to enable authentiсation for your endpoint. The same you can do with IPs.

When you have already created the endpoint, you can copy its URL from the Overview tab and use it for different purposes as well as in your OData consumer applications. You may also test the endpoint URL in the browser.

Overview tab of Endpoint

Having made a request in the browser, you will receive a response containing entity sets. In our example, we have received a response with 3 entity sets in JSON format — AddressTypes, BusinessEntityAddresses and Addresses.

Window with Entities

To receive all addresses with such parameters as AddressID, AddressLine, City, StateProvinceID, etc., we add the corresponding name of the entity set, Addresses, in the URL bar and check the displayed data.

Window with Entities 2

You may use the endpoint URL in any other OData consumer applications, such as Excel or Salesforce Connect, etc. You determine it yourself based on your business needs and actual demand.

Supported Versions of Microsoft SQL Server:

  • Microsoft SQL Server 2005
  • Microsoft SQL Server 2008
  • Microsoft SQL Server 2012
  • Microsoft SQL Server 2014
  • Microsoft SQL Server 2016
  • Microsoft SQL Server 2017

We welcome you to try OData REST API for SQL Server and enjoy full functionality of our platform by creating SQL Server OData connectors and exposing SQL server databases as OData endpoints and many more. Give us your feedback and share your thougts!


Loading Comments