docs.getDownloadUrl
This method returns a link you can use to download a static version of a document.
Parameters
| Name | Type | Description |
|---|
| doc_id | integer | (required)
Document ID of the file to download. You must have ownership of this document.
|
| doc_type | ["pdf", "txt", "original"] | (required)
The type of file to download. If "original", will get a link to the original file uploaded, regardless of its extension.
|
| api_key | string | (required)
API key assigned to your account.
|
| api_sig | string | (optional)
MD5 hash of the active request and your secret key. This is an optional security measure. See the signing documentation for more info.
|
| session_key | string | (optional)
A session key for a signed in user. If this parameter is provided, your application will carry out actions on behalf of the signed in user corresponding to the session key. Otherwise, your application will carry out actions on behalf of the user account associated with the API account. See the authentication documentation for more information
|
| my_user_id | string | (optional)
This parameter is intended for sites with their own user authentication system. You can create phantom Scribd accounts that correspond to your users by simply passing the unique identifier you use to identify your own user accounts to my_user_id. If you pass this parameter to an API method, the API will act as if it were executed by the phantom user corresponding to my_user_id. See the authentication documentation for more information.
|
Sample return XML
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
<download_link>http://documents.scribd.com/docs/28spn4epew03nig5z6za.txt</download_link>
</rsp>
Result explanation
| Name | Type | Description |
|---|
| download_link | string |
A link to the file
|
Error codes
| 401 | Unauthorized |
| 500 | Internal Server Error. Scribd has been notified about this problem. |
| 601 | Required parameter missing |
| 611 | Insufficient permissions to access this document |
| 627 | Document was not converted yet or cannot be converted. Please retry this method when the document has converted |
Back to Platform API Reference
