Sign In

Data Model API

You can provide other applications access to all (or part) of your data model by using an API key. The API key can be used to access your data model via REST, ODBC or JDBC interfaces.

API Keys

See Tools > API Keys to create an API key. Each API key is assigned a security role which controls what that API key can do (e.g. which tables it can view/insert/update/delete and which procedures it can call). A single API key can be used to connect via any method.

ODBC & JDBC Drivers

The AppSynergy Federated Data Model is fully compatible with third-party tools that work with ODBC and/or JDBC drivers. You can download the latest compatible drivers by clicking below.

offline_bolt

ODBC Driver Download

Use this driver with any ODBC compatible system.

offline_bolt

JDBC Driver Download

Use this driver with any JDBC compatible system.

RESTful API

The REST API allows you to make RESTful calls to your federated data model. These calls can interact with any data, including federated data linked via Smart Connectors.

Example Using CURL

The following example uses Curl to query the data model and get the results back in CSV format (result sets can be returned in JSON or CSV format):

curl "https://www.appsynergy.com/api?apiKey=YOUR_API_KEY&action=executeQuery&responseFormat=CSV&query=SELECT+*+FROM+Customers" > test.csv

Building The URL

In the above URL you would need to replace YOUR_API_KEY with a valid API Key.

The next parameter is the action parameter; this tells the API what action to take. All other parameters depend upon the value of the action parameter and are thus described below.

Any of the actions may be used with either GET or POST. Any POST body must be x-www-form-urlencoded encoded.

action=executeQuery

Allows you to run an SQL query and retrieve the results in either CSV or JSON format.

action=executeUpdate

Allows you to send an INSERT, UPDATE or DELETE statement to update the database. (A single INSERT statement may insert many rows in a single call.)

action=convertHtmlToPdf (PDF Generation)

This feature is configurable and must be enabled for your account.

This action allows you to convert HTML into a PDF file. The HTML must be in XHTML format meaning that all elements are closed (i.e. <br> will NOT work but <br/> will). Most of CSS 2.1 is supported.

Two parameters are required:

A PDF file will be generated and stored in the database's storage bucket. The response will look like the following:

{ "status":"OK", "errorMessage":"", "errorCode":"", "data":"MyHelloWorld.pdf;1168;1522959552652;database/files/bfefdf76-521c-4085-b5fb-ff02206d49ae.pdf" }

The value of the data attribute uses the AppSynergy DocumentField internal format and can therefore be stored directly into any column in the database defined as a DocumentField (DocumentFields are defined as VARCHAR(255) with a subtype of GCSFILE noted in the column comment).

General Limitations

Responses to Server API calls are limited to ~32MB.

By default API calls are limited to a certain number per hour to prevent runaway systems; the actual number is configurable.

Actions must complete in less than 60 seconds.