Steakscorp CaaS is inspired by Tom Dionysus' FOAAS project, and provides a RESTful solution to the problem of finding cat-facts to send to your friends.
Perform all API calls against /api (i.e. http://caas.steakscorp.org/api/?). Results are returned as a JSON string. Requests are made using the HTTP GET method, and parameters can be chained together as normal in the request body.
| Parameter | Input | Example output | Use |
|---|---|---|---|
| No parameters | N/A |
{ _id: 'cb40d5384945f2e07cfce3e0', text: 'Some cats enjoy luke-warm food.', source: 'Steakscorp Labs', url: 'https://steakscorp.org/?test_fact' } |
Returns a random cat-fact as a JSON document. |
intro |
yes, no (default no) |
{ _id: 'cb40d5384945f2e07cfce3e0', text: 'Hey! Did you know? Some cats enjoy luke-warm food.', source: 'Steakscorp Labs', url: 'https://steakscorp.org/?test_fact' } |
Prepends some introduction text in front of the cat-fact in the text field. |
newsub |
yes, no (default no) |
{ _id: 'cb40d5384945f2e07cfce3e0', text: 'You are now subscribed to Cat-Facts! Some cats enjoy luke-warm food.', source: 'Steakscorp Labs', url: 'https://steakscorp.org/?test_fact' } |
Prepends some new subscription text in front of the cat-fact in the text field. |
unsub |
yes, no (default no) |
{ _id: 'cb40d5384945f2e07cfce3e0', text: 'Some cats enjoy luke-warm food. Reply "unsubscribe" to unsubscribe from this list.', source: 'Steakscorp Labs', url: 'https://steakscorp.org/?test_fact' } |
Appends some unsubscribe option text behind the cat-fact in the text field. |
notrecog |
yes, no (default no) |
{ _id: 'cb40d5384945f2e07cfce3e0', text: 'Command not recognized. Some cats enjoy luke-warm food.', source: 'Steakscorp Labs', url: 'https://steakscorp.org/?test_fact' } |
Appends command not recognized text in front of the cat-fact in the text field. |
exclude |
comma-seperated source names (default include all sources) e.g. Steakscorp+Labs,Evilcorp |
{ _id: '83d6305cb818d7589024f750', text: 'Cats have over 100 sounds in their vocal repertoire.', source: 'Not-Steakscorp Labs', url: 'https://steakscorp.org/?notlabs&test_fact' } |
Excludes a cat-fact from a given data source or sources from being returned. |
include |
comma-seperated source names (default include all sources) e.g. Evilcorp,Not-Steakscorp+Labs |
{ _id: '1414cda7ccb7b6099e36a065', text: 'Cats cannot taste sweet things.', source: 'Evilcorp', url: 'https://steakscorp.org/?evilcorp&test_fact' } |
Includes a cat-fact from a given data source or sources from being returned, and excludes all other sources. |
id |
id of a cat-fact (default random) e.g. cb40d5384945f2e07cfce3e0 |
{ _id: 'cb40d5384945f2e07cfce3e0', text: 'Some cats enjoy luke-warm food.', source: 'Steakscorp Labs', url: 'https://steakscorp.org/?test_fact' } |
Returns a specific cat-fact by id. |
The source for Steakscorp CaaS is hosted on GitHub here. This project is inspired by Tom Dionysus' FOAAS project, the source of which is also hosted on GitHub here.
This web service is powered by Django, with a MongoDB + Python back-end. This page is powered by Bootstrap and the Full Width Pics template, and is valid HTML5.
