Retrieve data from kintone via its API. kintone is an enterprise application platform.
Stable CRAN version
To use kintone API, kntnr needs the following environmental variables.
KNTN_URL: kintone URL
KNTN_AUTH_TYPE: authentication type (password or token)
KNTN_AUTH: API token or BASE64 encoded login name and password
kntn_set_auth() sets these environmental variables interactively.
library(kntnr) # password-based authentication kntn_set_auth() # token-based authentication kntn_set_auth(auth_type = "token")
To set another information, run
overwrite = TRUE.
kntn_set_auth(overwrite = TRUE)
Or, unset the environmental variables by
You can define the environmental variables in
.Renviron, which is loaded at the start of an R session. For more information, see
KNTN_URL = https://example.kintone.com/ KNTN_AUTH_TYPE = token KNTN_AUTH = 1234567890
kntn_record() gets a single record from the specified kintone application.
kntn_records() retrieves multiple records at once. If the number of records is more than records_per_request (the default is 100),
kntn_records() automatically splits the request into smaller subrequests.
app <- 10 # get a single record d <- kntn_record(app, id = 1) # get records up to 1000 (default) d <- kntn_records(app) # get records up to 5000 records at the latency of 500 records/request. d <- kntn_records(app, max_records = 5000, records_per_request = 500L)
Some types like SUBTABLE are converted as nested data.frame. You can unnest them by using
kntn_file() gets a file from kintone API and try to parse it with
httr::content(). If you want to parse it by yourself, specify
as = "raw" or
as = "text".
d <- kntn_record(app, id = 1) f <- kntn_file(fileKey = x$Attachment[]$fileKey)