Description

The API Server is designed to let you quickly build and deploy uniform APIs for disparate data sources, without needing custom development for each resource.

Using simple point-and-click interfaces, you can configure connections and build a REST API for leading RDBMSs, popular file formats (CSV, TSV, JSON, etc.), on-premises sources (QuickBooks, MS Excel, MS Access, etc.), NoSQL databases, and SaaS applications. Since the API Server is installed directly on your server, you can easily provide both local and remote access to the API.

What does an API by the CData API Server look like?
The CData API Server generates APIs using the OData protocol by default, making them immediately compatible with popular BI, reporting, and ETL tools, as well as common development frameworks. Once you've configured a connection and added resources, you can send HTTP requests to read and write data seamlessly.

For tools that support OData natively — like Microsoft Power BI or Salesforce Lightning Connect — the process runs and managed automatically in the background. If you're coding the requests manually, the API Server provides an API page listing available endpoints and corresponding HTTP methods for quick reference.

The API page of the API Server contains resources represented as Tables from various data sources, alongside Stored Procedures that run on those sources. You can either use an OData endpoint URL or an OpenAPI endpoint URL. These base URLs can be used in your querying application, paired with the table or stored procedure name.

The API Server also automatically creates endpoints for resource discovery, rich metadata retrieval, and a Swagger endpoint, allowing integration with Swagger-capable tools and libraries. Each configured resource gets its own dedicated endpoint, enabling direct read and write operations — governed by the source's permissions.

For example, setting up a Salesforce connection lets you interact with Account data through an endpoint like: http://address:port/api.rsc/Salesforce_Account. This flexible, standards-based setup ensures smooth API integration with modern web apps and services, supporting formats like JSON and CSV.

Beyond OData: Standard-Based API Server Drivers
For tools and applications that don't natively support the OData protocol, CData Software provides a range of standards-based drivers — including ADO.NET, JDBC, and ODBC — along with integrations for Microsoft Excel, SSIS, BizTalk, and PowerShell. These drivers ensure seamless data connectivity through the API Server, offering broad compatibility with your existing tools.

Once the connection to the API Server is configured, the drivers behave like any standard database driver, supporting schema discovery and enabling full CRUD (Create, Read, Update, Delete) operations — giving you the flexibility to interact with your data from your preferred environment.

How do I get started?
CData API Server is available for Windows, Mac, and Linux/Unix, offering seamless cross-platform support. Quickly create REST APIs for real-time, bi-directional access to data from 270+ sources — including popular RDBMS platforms, NoSQL databases, and SaaS applications — whether the data is on-premises or in the cloud.

API Server Drivers are also offered for Windows, Mac, and Linux/Unix, tailored to fit your preferred technology. Pick the driver that meets your requirements and start integrating live data into your favorite apps and environments today.

Additional Information