RIC One API Deployment Overview Albany, NY February 2016

In this session… Workshop Approach RIC One API Deployment Model Data Hierarchy Authenticating Quantity and Quality of Data About the xPress API

Workshop Approach Our districts want apps! We needed a common approach and tool to help achieve our objectives for today 1.Teach you about RIC One and xPress 2.Emerge with a usable consumer You have choices! – Common Framework – RIC One Client Libraries – Your tools We’re here to help Your App Common Framework Your Tools or RIC One Client Libs or

API Appliance RIC One API Appliance District SIS Data xPress API { } Apps

Deployment: 12 Appliances/Endpoints RIC One API Appliance Appliances are designed to be deployed & hosted on RIC networks

API Appliance Functionality Transforms and loads data from multiple districts and SISs into a normalized form at each RIC Stores multiple districts’ data in a multi-tenant relational data store Securely serves data to authorized clients using one or more RESTful APIs (xPress)

Endpoint Access RIC Network / Operator (Multi-Instance) API Appliance VM Image Linux Host API Data Core Ingestion SFTP SIF Agent xPress Client Docker AWS (Single Instance; no PII) Config Auth Client App

Data Grouping Hierarchy RIC One RIC Appliance District 1SchoolsDistrict 2Schools RIC Appliance District 3SchoolsDistrict 4Schools

Authenticating The API endpoint “environments” you connect to are configured automatically based on – Districts to which you have been granted access – Security profile that has been applied to your application based on needs and district permissions

Getting a Token POST { “username”:” ”, ”password”:” ” } [ { "name": "Workshop Provider", "href": " "provider_id": "workshop", "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBsaWNhdGlvbl9pZCI6IkNhc3RsZUxlY XJuaW5nT25saW5lIiwiaWF0IjoxNDU1MjA1MzQ1LCJleHAiOjE0NTUyMDg5NDUsImlzcyI6 Imh0dHA6Ly9zZWN1cml0eS5vbmVhcGlkZXYub3JnLyJ9.NKVseJM69pldSNKvq8ZJU8597 0VMy1-VVME4rb42TQ0" }, { "name": "Workshop Provider backup", "href": " "provider_id": "workshop2", "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBsaWNhdGlvbl9pZCI6IkNhc3RsZUxlY XJuaW5nT25saW5lIiwiaWF0IjoxNDU1MjA1MzQ1LCJleHAiOjE0NTUyMDg5NDUsImlzcyI6 Imh0dHA6Ly9zZWN1cml0eS5vbmVhcGlkZXYub3JnLyJ9.NKVseJM69pldSNKvq8ZJU8597 0VMy1-VVME4rb42TQ0" } ]

Data Quality and Quantity Today we will be using test datasets that do not necessarily represent production data in terms of quality or quantity There will be some variance in loaded data based on ingestion method and underlying SIS data RIC One team will work with you to ensure you get what is required by your app We’re also interested in additional use cases that you would like to support (e.g. gradebook assignments, assignment grades, assessment)

API Data Model SIF xPress Roster API = 8 Objects/Resources xStudent xStaff xContact xSchool xLea xCalendar xRoster xCourse

API Data Model The full set of elements is visible in the Swagger by navigating to a resource and clicking “Model” (elements are aligned to & defined by CEDS) If there are data elements not present in the model, please let us know so that we can consider it for our roadmap

About the xPress API Application Programming Interface An interface has both a WHAT and HOW [ WHAT = DATA ] & [ HOW = TRANSPORT ] The xPress data model was developed by the RIC One team and based on the Common Education Data Standards ( We partnered with the Access 4 Learning Community (formerly SIFA) to publish xPress as a national, open standard for rostering xPress uses SIF 3 as its RESTful transport standard

xPress IS NOT OLD SIF xPress IS NOT OLD SIF

xPress is… Modern RESTful Easy Implementable without middleware (ZIS)