Reconciliation API
Useful for resolving names, labels or codes against a dataset in Kasabi to find links to more data. This API is compatible with the Google Refine tool.
Table of contents
Endpoint URL
Login to test this query using our experimental API explorer
Authentication
You will need your API key (on your dashboard) in order to authenticate to this API. You have two options for authentication:
- By URL Parameter -- add the
apikeyparameter to your request URL, with your key as the value - By Request Header -- add a custom HTTP header called
X_KASABI_APIKEYto your HTTP request, with your key as the value
For more information on Kasabi authentication options read the authentication documentation. Your API key will need to be authorized to use this service.
Parameters
Detailed reference documentation for the request parameters for the Reconciliation API is available from the Google Refine project.
Read the Kasabi Reconciliation API docs for notes on how to use the API from within Google Refine
In summary the API supports performing reconciliation request for both single or multiple values:
| Parameter Name | Parameter Value(s) | Required? | Notes |
|---|---|---|---|
query | text to reconcile | Yes, unless queries parameter provided | Reconciles a single value |
queries | URL encoded JSON reconciliation query. See docs | Yes, unless query parameter provided | Reconciles multiple values and/or provide fine-grain control over reconciliation. |
HTTP Response Codes
Clients should be prepared to receive any valid HTTP response code. The following table lists the most frequently used codes
| Code | Meaning |
|---|---|
200 OK | Successful Request |
400 Bad Request | Missing or malformed SPARQL query |
401 Not Authorized | API key is not authorized to access the data |
Please also review our additional notes on response codes.
Response Formats
Responses from the Reconciliation API are always returned as JSON
The detailed reference documentation has example responses.
