Dev-logo
API Walkthrough
Resources
Developers

OrgSync API Getting Started


Introduction

OrgSync’s Application Programming Interface (API) provides IT departments with a secure way to access OrgSync. The API enables seamless integration between OrgSync and existing information systems and data warehouses. Institutions can pull OrgSync data into other databases on campus or push data into OrgSync. Other systems can include student information systems, calendaring software, learning management systems, and more.

The API also gives each campus the flexibility and creativity to create new automated processes to leverage the institutional involvement and assessment data collected within OrgSync. By bringing all of the data in-house, you can compare data collected in OrgSync with other data on your information systems for assessment purposes.

OrgSync works collaboratively with information technology (IT) staff to understand our API calls to figure out which works best for your situation and organizational needs.

Api-explanation

Benefits and Most Common Uses

The API allows each campus the flexibility and creativity to create campus specific processes to leverage the data in OrgSync collected from campus departments, programs, organizations and students. The most common uses include:

See Some Examples from our Campus Partners



How to Get Started

The OrgSync API is available to all customers with a Web Services API subscription. If that's you, then here is our API documentation. If you are not sure if your campus has an API subscription or you do not know whom to contact on your campus, then feel free to contact OrgSync Support.

Implementation Process

We recommend the following implementation :

  1. Contact OrgSync to subscribe to the API.
  2. Determine the data you would like to pull from OrgSync into other programs.
  3. Identify the appropriate campus IT people to be involved in this project.
  4. Schedule a technical call between OrgSync and your campus IT to discuss the project and timeline.
  5. Campus IT will develop a campus specific connector to pull data from OrgSync and then transform and push it into campus system(s).

Where is version 1?

If you're looking for version 1.0 of the API documentation, it still exists here.

Need Help?

We're always available if you need help or have any questions or suggestions.
972.907.0900 ext 2

Not a Developer?

The API is really best suited for developers only. If you are not a programmer, then we suggest you contact your Information Technology department to see if they have someone who can work with you. If you still cannot find anyone to help, then you may want to consider contracting with a campus approved, third-party development vendor.

For additional information, please contact OrgSync Support.