https://docs.xporter.com/assets/js/2a153360.7fd74cb7.js

1"use strict";(globalThis.webpackChunkcbuk_xporter_documentation=globalThis.webpackChunkcbuk_xporter_documentation||[]).push([[1302],{28453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>r});var o=n(96540);const i={},a=o.createContext(i);function s(e){const t=o.useContext(a);return o.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(a.Provider,{value:t},e.children)}},60894:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});const o=JSON.parse('{"id":"Xporter/getting-started/sandbox-access","title":"API Sandbox","description":"To aid you with exploring the value you can add to your application with Xporter, we offer a sandbox environment with demonstration schools.","source":"@site/docs/Xporter/getting-started/sandbox-access.md","sourceDirName":"Xporter/getting-started","slug":"/Xporter/getting-started/sandbox-access","permalink":"/docs/Xporter/getting-started/sandbox-access","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":5,"frontMatter":{"sidebar_position":5,"title":"API Sandbox","hide_table_of_contents":false},"sidebar":"tutorialSidebar","previous":{"title":"Register Your Application","permalink":"/docs/Xporter/getting-started/register-application"},"next":{"title":"Authentication","permalink":"/docs/category/authentication"}}');var i=n(74848),a=n(28453);const s={sidebar_position:5,title:"API Sandbox",hide_table_of_contents:!1},r=void 0,c={},d=[{value:"Accessing the Sandbox",id:"accessing-the-sandbox",level:2},{value:"Authenticating with the Sandbox",id:"authenticating-with-the-sandbox",level:2},{value:"Using the Sandbox",id:"using-the-sandbox",level:2}];function l(e){const t={a:"a",admonition:"admonition",h2:"h2",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.p,{children:"To aid you with exploring the value you can add to your application with Xporter, we offer a sandbox environment with demonstration schools."}),"\n",(0,i.jsx)(t.p,{children:"An API sandbox is a testing environment that allows you to test your application against the Xporter API without using real school data. The demonstration schools available on the sandbox provide a replica of live API functionality with fake data. This gives you the opportunity to experiment and try out new ideas without worrying about breaking anything or impacting your production application."}),"\n",(0,i.jsx)(t.h2,{id:"accessing-the-sandbox",children:"Accessing the Sandbox"}),"\n",(0,i.jsxs)(t.p,{children:["You can visit the API sandbox by visiting ",(0,i.jsx)(t.a,{href:"https://api.xporter.com/TryIt",children:"https://api.xporter.com/TryIt"})]}),"\n",(0,i.jsx)(t.p,{children:"From here you will be prompted to provide some details to authenticate before you can access API endpoints"}),"\n",(0,i.jsx)(t.h2,{id:"authenticating-with-the-sandbox",children:"Authenticating with the Sandbox"}),"\n",(0,i.jsx)(t.p,{children:"During application registration you will have been provided API details for two schools:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"DfE Number: 3281101"})," - a primary school"]}

1),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"DfE Number: 3281102"})," - a secondary school"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.admonition,{type:"tip",children:(0,i.jsx)(t.p,{children:"Both of these schools are utilising demostration data from the SIMS MIS, for the current academic year"})}),"\n",(0,i.jsx)(t.p,{children:"On the sandbox page you will be prompted for the following pieces of information:"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Relying Party Id: Your Application Id, entered during registration"}),"\n",(0,i.jsx)(t.li,{children:"School Estab Code: The school's DfE number"}),"\n",(0,i.jsx)(t.li,{children:"App Estab Secret: The school specific secret issued to you"}),"\n"]}),"\n",(0,i.jsx)(t.admonition,{type:"tip",children:(0,i.jsx)(t.p,{children:"For the two demo schools, the secret you have been issued is the same. Production schools will all have unique secrets"})}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["Enter the information provided into the ",(0,i.jsx)(t.strong,{children:"Obtain a token from Xporter STS"})," form"]}),"\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Get Token"})]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:"A token will be generated and you will see all of the endpoints appear in the left hand navigation pane."}),"\n",(0,i.jsx)(t.h2,{id:"using-the-sandbox",children:"Using the Sandbox"}),"\n",(0,i.jsx)(t.p,{children:"You can now try out each of the endpoints available on the Xporter platform for accessing school data."}),"\n",(0,i.jsx)(t.p,{children:"You can review how the request was constructed, how to add parameters and options including how changing them affects the output of data."}),"\n",(0,i.jsx)(t.p,{children:"You will receive real responses from the API that you can expect your application to receive and view them in either JSON or tabular format."}),"\n",(0,i.jsx)(t.p,{children:"Each endpoint may have its own options and parameters that you can set and experiment with."}),"\n",(0,i.jsx)(t.p,{children:"Check out the Concepts section for more detail on parameters, options, pagination, callbacks and more."})]})}function h(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}}}]);