4thefile_api_reference
Differences
This shows you the differences between two versions of the page.
|
4thefile_api_reference [2010/11/05 20:04] jay |
4thefile_api_reference [2011/01/04 22:19] (current) jay |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Introduction ===== | ===== Introduction ===== | ||
| - | The 4theFile API is a REST-style API that uses simple standard technologies: HTTP requests with Basic auth, and XML or JSON response content. The API is designed primarily to allow developers and maintainers of web applications to easily provide an email interface to their applications without all the hassles involved in running an email server and parsing complex multi-part email messages, possibly with inline images, html, and attachments -- 4theFile takes care of all that for you. | + | The 4theFile API is a REST-style API that uses simple standard technologies: HTTP requests with Basic auth, and XML or JSON response content. The API is designed primarily to allow developers and maintainers of web applications to easily provide an email interface to their applications and integrate the list of submitted emails into their application's interface -- without all the hassles involved in running an email server and parsing complex multi-part email messages, possibly with inline images, html, and attachments. 4theFile takes care of all the messy stuff for you. |
| For more information, see the [[4theFile API | 4theFile API Overview]] | For more information, see the [[4theFile API | 4theFile API Overview]] | ||
| Line 15: | Line 15: | ||
| <method> <endpoint><resource>.<format>[?<querystring>] | <method> <endpoint><resource>.<format>[?<querystring>] | ||
| - | Example: to GET the list of 4theFile Resources in Collection HJf56 that have "tag" 99 in XML format, the API resource is /collections/HJf56 and the whole request would look like: | + | Example: to GET the list of 4theFile Resources in Collection HJf56 that have "tag" 99 in XML format, the API resource is /collections/HJf56/resources and the whole request would look like: |
| - | GET https://4thefile.com/api_v1/collections/HJf56.xml?tag=99 | + | GET https://4thefile.com/api_v1/collections/HJf56/resources.xml?tag=99 |
| - | * Each request must be authenticated with your username and apiKey (used as the Basic auth password). Most http clients and client libraries have support for Basic auth, so you don't need to be concerned with the details of the HTTP headers. For example, when using the Curl command line client you only need to add the -u option //curl -u user:apiKey// | + | * Each request must be authenticated with your username and apiKey (used as the Basic auth password). If you don't have an apiKey yet, please [[tech_support_contacts | contact our support team]]. Most http clients and client libraries have support for Basic auth, so you don't need to be concerned with the details of the HTTP headers. For example, when using the Curl command line client you only need to add the -u option //curl -u user:apiKey// |
| * If your request is successful, you'll receive an HTTP "success" response code (usually 200 unless otherwise noted in the documentation for the resource) and the content in the format you specified (with appropriate MIME type, text/xml or application/json). | * If your request is successful, you'll receive an HTTP "success" response code (usually 200 unless otherwise noted in the documentation for the resource) and the content in the format you specified (with appropriate MIME type, text/xml or application/json). | ||
| Line 33: | Line 33: | ||
| In each resource description we've provided a Curl command line which may be useful for exploring or testing the API. For actual integration with your application you'll probably want to use a language-specific HTTP library (such as libCurl, or LWP for perl). For more info on Curl and libCurl http://en.wikipedia.org/wiki/CURL | In each resource description we've provided a Curl command line which may be useful for exploring or testing the API. For actual integration with your application you'll probably want to use a language-specific HTTP library (such as libCurl, or LWP for perl). For more info on Curl and libCurl http://en.wikipedia.org/wiki/CURL | ||
| - | We've shown most example responses in XML, but currently all responses are also available as JSON. A .json response format is shown on the first example page ([[get_collections | GET /collections]]) | + | We've shown most example responses in XML, but currently all responses are also available as JSON. An example .json response is shown on the first example page for ([[get_collections | GET /collections]]) |
| ==== /collections ==== | ==== /collections ==== | ||
| Line 54: | Line 54: | ||
| GET /collections/:collectionkey/resources.format returns the list of Resources in Collection :collectionkey | GET /collections/:collectionkey/resources.format returns the list of Resources in Collection :collectionkey | ||
| * response formats supported: .xml, .json | * response formats supported: .xml, .json | ||
| - | * query parameters: per_page (optional - max resources to return at once, default 30), page (optional, default 1) | + | * query parameters: |
| + | * per_page (optional - max resources to return at once, default 30) | ||
| + | * page (optional, default 1) | ||
| + | * tag (optional - only Resources with matching tag will be returned. the special tag "untagged" will return all Resources in the Collection that don't have any tags) | ||
| + | * cdate (optional - only resources with collection_id or tags modified since cdate will be returned. cdate must be in yyyy-mm-dd or "yyyy-mm-dd hh:mm:ss" format) | ||
| * [[get_collection_resources | details and example]] | * [[get_collection_resources | details and example]] | ||
| Line 71: | Line 75: | ||
| * [[get_resource_details | details and example]] | * [[get_resource_details | details and example]] | ||
| + | ==== /resources/:resourcekey/attachments ==== | ||
| + | |||
| + | GET /resources/:resourcekey/attachments.format returns a list of direct links to any attachments in the top-level message for | ||
| + | :resource, plus some meta data. this could be useful in a specialized collection where, for example, the 1st attachment is known to always include a scanned image of a purchase receipt. | ||
| + | * response formats supported: .xml, .json | ||
| + | * [[resource_attachment_list | details and example]] | ||
| ==== /collections/:collectionkey/resources/:resourcekey ==== | ==== /collections/:collectionkey/resources/:resourcekey ==== | ||
4thefile_api_reference.1288987443.txt.gz · Last modified: 2010/11/05 20:04 by jay