scribd_query: Workhorse function
In cloudyr/rscribd: Scribd API Client Package for R

Description Usage Arguments Details Value Author(s) References

View source: R/http.r

Execute a Sribd API query

scribd_query(method, args = NULL, verb = "GET",
             api_key = Sys.getenv("SCRIBD_API_KEY"),
             session_key = Sys.getenv("SCRIBD_SESSION_KEY", NULL),
             my_user_id = Sys.getenv("SCRIBD_USER", NULL),
             secret_key = Sys.getenv("SCRIBD_SECRET_KEY", NULL),
             base_url = "https://api.scribd.com/api", 
             ...)

`method`	A character string containing an API endpoint.
`args`	A list containing named arguments to pass as query string parameters to the API endpoint.
`verb`	A character string containing an API verb. One of “GET” or “POST”.
`api_key`	A character string containing a Scribd API key. This is required for all requests.
`session_key`	Optionally, a character string containing a Scribd sesion key. If supplied, requests are performed on the user account associated with the session key rather than the account associated with the API key.
`my_user_id`	Optionally, a character string containing a “phantom user account” with which to perform the API operation. This allows, for example, for a single developer's account to contain information for numerous users without requiring them to register an account with Scribd.
`secret_key`	Optionally, a character string containing an API secret key. If supplied, API requests are made with an additional MD5 hash of the request to prevent unauthorized use of an API key. This setup must also be configured in the Scribd API account settings by setting the “Require API Signature” option to “Require signature”.
`base_url`	A character string containing the base URL for API endpoints. Provided for forward compatibility in the event of a URL change.
`...`	Other arguments passed to `GET` or `POST`.

This is the basic workhorse function that performs API requests. It is exposed for advanced users for purposes of troubleshooting or custom requests not provided in the rscribd wrapper functions. All arguments to this function can be passed via ... to any other rscribd function, allowing varying levels of request authentication.

A list containing the parsed XML response from the Scribd API.

Thomas J. Leeper

Using the API

API Endpoints

cloudyr/rscribd documentation built on May 13, 2019, 8:22 p.m.