Search

Getting Started

Version 25.3.9411

Getting Started

CData API Server is a lightweight web application that enables you to create and publish data APIs quickly, without the need for custom development. With the application’s intuitive point-and-click interface, you can easily configure access for popular clients such as Microsoft Power BI, Salesforce Lightning Connect, SharePoint External Lists, Microsoft Excel, Microsoft PowerPivot, and more. Available to install on-premises or in the cloud, the easy-to-use interface means that you can build and publish enterprise-ready REST APIs in minutes!

Key Features

  • API accessibility: Generate APIs for SQL, NoSQL, and other data sources (for example, SQL Server, MySQL, DB2, Mongo, Cassandra, flat files, and more).

  • API management: Monitor the APIs, enable logging, and configure rate limits.

  • Connectivity: Connect with your data using these methods:

    • Standard drivers: CData drivers make it simple to connect directly with API Server from virtually anywhere.

    • OData protocol: The OData protocol is widely supported by developer tools, and dozens of client libraries are available for working with OData.

    • JSON format: Interact with your data directly through JSON APIs. Web developers can interact through JSON and JSON entry-points with no client-side requirements other than standard JavaScript.

    • Modern web API integration: Employ API Server’s unmatched power and flexibility in integrating with other systems and applications. You can access many interfaces through simple standards-based protocols like SOAP, REST, HTML, JSON, CSV, and more.

  • On-Premises and Cloud Hosting: API Server is available either as an on-premises application (Microsoft Windows, UNIX or Linux, and macOS) or in the cloud (Microsoft Azure, Amazon, Google).

  • Universal publishing: Host API Server on intranets, internet-facing servers, or in the cloud.

Core Concepts

  • Admin API: An admin API provides administrators or authorized users access to administrative functions within an application. These APIs enable you to manage and control resources, user settings, tasks (like creating tables or stored procedures), and so on within the application.

  • Connection: A connection is a link to a source. For more information, see Connections.

  • Connector: A connector is a specific connection type. For example, you can make multiple connections to different Microsoft Excel spreadsheets by using the Microsoft Excel connector. For more information, see Connections.

  • OData API: An OData API is a RESTful API that follows the Open Data Protocol (OData) standard. It enables the creation, querying, and manipulation of data via a consistent set of rules for URL conventions, query options, data formats, and HTTP methods. This protocol enables easy data access and interoperability across different systems.

  • Table: A table is a structured set of data within a database. The data is organized into rows and columns, similar to a spreadsheet. In the table, each row corresponds to a data record, and each column represents a specific attribute of the data in that record. In the OData protocol, tables are also called resources.

  • Stored Procedure: A stored procedure is a collection of SQL statements that are stored in a database, can be executed as a single unit to perform specific tasks (for example, data retrieval or updates), and can be reused as necessary. In OData, stored procedures are also called actions.

  • Source: A source is the origin (database, data warehouse, and so on) from which your data flows.

Quick-Start Guide

This section provides steps for initial setup of API Server, and it provides links to specific sections of API Server documentation that explain how to use the application. In addition, you can find support resources in the Getting Support section.

Initial Setup

Follow these steps to install and start API Server:

  1. Download the installation file from the API Server page on the CData website.

  2. Follow the installation instructions for your platform in Installation to install API Server.

  3. Follow the configuration instructions for your platform in Configuration.

  4. After you log in, navigate to the Settings page and click the License tab.

  5. Click the Add License button and fill out the form in the Install License dialog box to activate API Server. Then, click Save to exit the dialog box.

Surfacing APIs

The following sections explain the steps that you need to follow to expose an API for your data source:

  1. Connecting to Your Data Store

  2. Building the API

  3. Configuring the API

  4. Querying the API

  5. Monitoring the API

Getting Support

For assistance with using API Server, use the following resources:

  • This documentation (which provides detailed information about each feature of API Server as well as how to use and configure the features)

  • CData Technical Support