# Prolific API access This class provides functionalities for accessing the [Prolific API](https://docs.prolific.co/docs/api-docs/public/). The core method for this purpose is `access`, which can be used to create, review, change, manage and delete studies on the Prolific platform. **The fields and methods are available as in RefClass or S4 objects (see examples).** class ## Fields - **`accessors`**: (`character`): The commands for accessing the API. The command for each type of access method can be altered using this field. The default is ``` accessors = c( get = "curl", post = "curl -X POST", put = "curl -X PUT", patch = "curl -X PATCH", delete = "curl -X DELETE" ) ``` Note: **A value for each of the names `(get, post, put, patch and delete)` is required, as these represent the methods that can be used when accessing the API.** - **`api_token`**: (`character`): The [Prolific API token](https://docs.prolific.co/docs/api-docs/public/#section/Authentication). - **`entrypoint`**: (`character`): The [API's entrypoint URL](https://docs.prolific.co/docs/api-docs/public/#section/Get-started/Conventions). ## Methods ### `access` Main method for accessing the [Prolific API](https://docs.prolific.co/docs/api-docs/public/) #### Parameters - **`endpoint`**: (`character`): - **`method`**: (`character`): - **`data`**: (`json string`, `json file`, `list`, `prolific_study object` or `NULL`) - **`as_list`**: (`logical`): #### Return Value A `list` or `json string`, depending on argument `as_list`. #### Usage ``` api_access$access( endpoint, method, data, as_list ) ``` ### `check_authorization` Check whether the [API authorization](https://docs.prolific.co/docs/api-docs/public/#section/Authentication) works #### Return Value A `logical` value that indicates whether the [API authorization](https://docs.prolific.co/docs/api-docs/public/#section/Authentication) works. #### Usage ``` api_access$check_authorization() ``` ## Examples ```r library(prolific.api) # Create API access prolific_api_access <- api_access(api_token = "") # View fields ## RefClass Methods prolific_api_access$accessors prolific_api_access$api_token prolific_api_access$entrypoint ## S4 Methods accessors(prolific_api_access) api_token(prolific_api_access) entrypoint(prolific_api_access) # Change fields # (this is usually only required for the api_token) # replace in the by the actual API token # before running these lines ## Not run: ## RefClass Method prolific_api_access$api_token <- "" ## S4 Method api_token(prolific_api_access) <- "" ## End(Not run) # Note: For the following code to work, # you have to replace in the lines above by the actual API token ## Not run: # Check wheter Authorization is working ## RefClass Method prolific_api_access$check_authorization() ## S4 Method check_authorization(prolific_api_access) # Obtain list of existing studies ## RefClass Method list_of_studies <- prolific_api_access$access( endpoint = "studies", method = "get", as_list = TRUE ) ## S4 Method list_of_studies2 <- access( prolific_api_access, endpoint = "studies", method = "get", as_list = TRUE ) ## End(Not run) ```

api_access function