SIMS 8 Interfacing and Web APIs Basics
Learn about SIMS 8 interfacing, security basics, obtaining access tokens, formulating API calls, and accessing data using Web APIs. Understand how to implement OData, secure with OAuth, and manage APIs effectively. Examples and guidance provided for easy understanding.
Download Presentation
Please find below an Image/Link to download the presentation.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author. If you encounter any issues during the download, it is possible that the publisher has removed the file from their server.
You are allowed to download the files provided on this website for personal or commercial use, subject to the condition that they are used lawfully. All files are the property of their respective owners.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.
E N D
Presentation Transcript
WEB APIS ESS SIMS 8 / DeX APIs are: What are the SIMS 8 / DeX APIs Web based Implement Odata Secured by SIMS ID via OAuth 2 Managed by API Manager Documented via API Manager
BASICS OF SIMS 8 INTERFACING Security Obtain an Access Token Bearer Tokens can be obtained via Postman or a variety of coding libraries. URL https://sts.sims.co.uk/connect/token?Content-Type Body Data grant_type: client_credentials Examples and more help are available at SIMS Partners.com 8 - Access Token | Capita Portal (sims- partners.com) client_id: {{client_id}} client_secret: {{client_secret}} scope: partnerserverapplication partner acr_values: orgselected:{{organisation_id}} POST: Returns a bearer token
Get Some Data Formulate the call <Base URL>/<Service>/<Version>/<Sub Domain> <Base URL> https://seli00apm01.azure-api.net/ssli01/ <Service> Learner|Staff|Atttendance| <Version> V3 <Sub Domain> LearnerIndentifiers | StaffIndentifiers | AttendanceRecord | Headers Authorization : Bearer {{token}} Ocp-Apim-Subscription-Key: {{subsciption_keyV3}} WEB API CALLS Whilst there are many additional options for Odata, see OData - the Best Way to REST, the key goal is to make the task simple.
Example https://seli00apm01.azure- api.net/ssli01/Learner/V3/LearnerIdentifiers WEB API CALLS The call will return a set of JSON records and classes are provided to assist with deserialization with a link on the next page { "ExternalID": "8baf79e2-cd33-43a0-832d-00951f7b5f79", "Forename": "Dwayne", "Surname": "Johnson", "GenderCategory": "Male", public class TLearnerIdentifier { public Guid ExternalID; public string Forename; public string Surname; public string GenderCategory; public int? AgeMonths; public bool? DoNotCommunicate; public TLearnerGroup CurrentYearGroup; public TLearnerGroup CurrentPrimaryClass; public TLearnerGroup CurrentHouse; public string OnRollState; public DateTime? DateOfApplication; } "AgeMonths": 33, "DoNotCommunicate": false, "OnRollState": "Future", "DateOfApplication": "2020-05-14T00:00:00Z", "Photograph": null, "CurrentYearGroup": { "Description": "Year 2", "ExternalID": "7d59c220-a68a-41a6-a19c-93de70616046", "Type": "PastoralGroup.Definition.YearGroup" }, "CurrentPrimaryClass": { "Description": "My Class DUS", "ExternalID": "0d77113d-6a7f-44f5-acfe-c5b89c8bc49b", "Type": "PastoralGroup.Definition.PrimaryClass" }, "CurrentHouse": null },
WEB API CALL RESOURCES Resources Getting Started: https://www.sims- partners.com/Product/SIMS8/API/Start-Point There are many resources on the SIMS-Partners.Com site but the 4 links on the left are probably the most important ones to get a Technical Integrator started. Formal Documentation: Products: Details - Microsoft Azure API Management - developer portal (azure-api.net) API Overviews: https://www.sims- partners.com/Product/SIMS8/APIs/V3/Index Data Models: SIMS 8 - Models 28012021 | Capita Portal (sims-partners.com)
