Introduction

The Slipcase API is a simple yet powerful RESTful service that allows developers to programmatically integrate the Slipcase curated content service into their web or mobile application. The API has predictable resource-oriented URLs, returns JSON or XML encoded responses, and uses standard HTTP response codes.

Note

This documentation is for version 2 of the Slipcase API, which is not fully backwards compatible with version 1.

Base URL

https://widget.slipcase.com/api/v2/

The API version is encoded in the URL path (second segment), not as a query parameter.

Parameter conventions

• Input parameters are passed as standard query string key/value pairs appended to the base URL.
• Parameters that accept multiple values should have values provided comma separated.
• The full query string should be URL encoded (e.g. spaces become %20).
• The API is read-only — all HTTP requests use the GET verb.

Integration methods

There are several supported ways to utilise the API:

Pull requests

The most standard setup. Your application programmatically makes requests to the Slipcase API and presents the results to your end-user. Results can be shown directly or through a local caching mechanism.

Push requests

Slipcase can push articles to your own web-service. A code-runner service calls the Slipcase API with your query parameters and scheduling, then each article in the result set is POSTed to your web-service. Contact a Slipcase engineer for this setup.

File based

Slipcase persists articles in a JSON document in an AWS S3 bucket or a remote sFTP server that your application can retrieve at its convenience. Articles are saved in a date-encoded directory structure:

/YYYY/MM/DD/article_id.json