REST API Reference
Overview
This page is a reference for the Card Foundry REST API.
The API provides access to resources (data entities) via URI paths. To use this API, your application will make an HTTP request and parse the response.
For resources of the form /resource/{parameter}, you must supply parameter in the URI.
Authentication
Authentication is handled through HTTP basic access authentication over SSL/TLS. Credentials should be sent with every request.
HTTP Status Codes
This API attempts to return appropriate HTTP status codes for every request.
- 200 OK: Success!
- 400 Bad Request: The request could not be fulfilled due to client error. The HTTP response body will contain an error message.
- 401 Unauthorized: Authentication credentials were missing or incorrect.
- 404 Not Found: The URI requested is invalid or the resource requested does not exists.
- 405 Method Not Allowed: The request method specified (GET, POST, PUT, DELETE) is not supported by the requested resource.
- 500 Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request.
- 501 Not Implemented: The server does not support the functionality required to fulfill the request.
Encodings
JSON is the only encoding currently supported.
For all responses that have content bodies, the content type application/json; charset=utf-8 is sent in the response header.
When sending files, use the content type multipart/form-data.