4thefile_api_reference
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| 4thefile_api_reference [2010/11/05 20:07] – 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: | + | The 4theFile API is a REST-style API that uses simple standard technologies: |
| For more information, | For more information, | ||
| Line 15: | Line 15: | ||
| < | < | ||
| - | Example: to GET the list of 4theFile Resources in Collection HJf56 that have " | + | Example: to GET the list of 4theFile Resources in Collection HJf56 that have " |
| - | GET https:// | + | GET https:// |
| - | * 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: | + | * 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: |
| * If your request is successful, you'll receive an HTTP " | * If your request is successful, you'll receive an HTTP " | ||
| 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:// | 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:// | ||
| - | We've shown most example responses in XML, but currently all responses are also available as JSON. A .json response | + | We've shown most example responses in XML, but currently all responses are also available as JSON. An example |
| ==== / | ==== / | ||
| Line 57: | Line 57: | ||
| * per_page (optional - max resources to return at once, default 30) | * per_page (optional - max resources to return at once, default 30) | ||
| * page (optional, default 1) | * page (optional, default 1) | ||
| - | * tag (optional - only Resources with matching tag will be returned) | + | * tag (optional - only Resources with matching tag will be returned. the special tag " |
| + | * cdate (optional - only resources with collection_id or tags modified since cdate will be returned. cdate must be in yyyy-mm-dd or " | ||
| * [[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]] | ||
| + | ==== / | ||
| + | |||
| + | GET / | ||
| + | :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]] | ||
| ==== / | ==== / | ||
4thefile_api_reference.1288987665.txt.gz · Last modified: 2010/11/05 20:07 by jay