4thefile_api_reference
Differences
This shows you the differences between two versions of the page.
|
4thefile_api_reference [2010/11/08 21:56] jay |
4thefile_api_reference [2011/01/04 22:19] (current) jay |
||
|---|---|---|---|
| Line 19: | Line 19: | ||
| GET https://4thefile.com/api_v1/collections/HJf56/resources.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 58: | Line 58: | ||
| * page (optional, default 1) | * 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) | * 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 74: | 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.1289253370.txt.gz ยท Last modified: 2010/11/08 21:56 by jay