README.md

In samterfa/rqmlativ: Creates R Functions for Skyward Qmlativ's Generic API

rqmlativ

This repo provides an SDK for Skyward's QMLATIV generic API.

Install

remotes::install_github("samterfa/rqmlativ")

Getting Started

Follow Skyward's instructions for creating a Qmlativ API user here. Select "Generic" for the API Type, and OAuth 2.0 as the authentication type.

Usage

Begin by setting relevant environmental variables based on the credentials created above.

Sys.setenv(SkywardConsumerKey = {YourConsumerKey})
Sys.setenv(SkywardConsumerSecret = {YourConsumerSecret})
Sys.setenv(SkywardBaseUrl = {YourBaseUrl})

Or, even better, place the above in a .Renviron in your working directory so that they are automatically loaded when using rqmlativ.

Your base url is likely your Skyward URL but ending in API instead of STS.

Then make a call!

library(rqmlativ)
#> 
#> Attaching package: 'rqmlativ'
#> The following objects are masked from 'package:methods':
#> 
#>     getClass, getGroup
#> The following object is masked from 'package:base':
#> 
#>     getElement

listEntities(Name = T)
#> Adding .tokenCache/rqmlativToken to .gitignore
#>                              Name
#> 1               Minnehaha Academy
#> 2  Minnehaha Academy Upper School
#> 3  Minnehaha Academy Lower School
#> 4 Minnehaha Academy Middle School

Resources

Function documentation for this package is available at https://samterfa.github.io/rqmlativ/reference/index.html.

samterfa/rqmlativ documentation built on April 2, 2021, 12:03 p.m.