All Categories ​ > ​ ​Network Administrator ​ > ​   Open API Integration

Open API Integration

Updated by Ester Villegas

SchedulePro makes multiple resources available for you to access and use in a variety of applications and types of integrations.

This article contains the step by step instructions to set up the access to our API protocols for real-time data exchange between systems.

The current up-to-date API’s available can be found on the SchedulePro dev portal.

Step by step instructions 

  1. [Client] to provide an email address we will be using to create the account to access our APIs (the developer portal account). We recommend for this to be a service account.
  2. SchedulePro will grant the provided account (email address) access to the API dev page to test and prod.
  3. [Client] will receive an email (to the provided account) containing the temporary password to access the developer portal.
  4. [Client] can now test access to the SchedulePro dev portal.
  5. SchedulePro will generate a set of subscriptions keys for test and prod to use to access our publicly available APIs.
  6. [Client] will receive an email (to the provided account) containing the primary and secondary Ocp-Apim-Subscription-Keys
  7. SchedulePro will add an employee profile with the email address provided to all sites that. EmployeeID: INTEG_USER, Email Address: email provided
  8. SchedulePro will assign a System Admin role to the INTEG USER.
  9. SchedulePro will enable the Integration Token feature.
  10. [Client] will need to login to one of the sites and create an integration token (see section Acquiring a SchedulePro integration token within Getting Started article) - one for test and one for prod instances. The token needs to be saved on creation because after creation, the token won’t be available for copy anymore. After the token is created, the org GUID for the site will show. Save that value too.
  11. [Client] can start testing API calls.
    Three things are needed to make API calls to Spro:
    1. Token – it will need to be passed on as a Authorization Header in the form “Bearer [integration token]”
    2. Subscription key - Received via email to the email provided. Can be found in the developer portal https://developer.scheduleproweb.com/profile
    3. organizationGUID - you can retrieve that value from the Integration token page in Spro. Each site has its own.
    Must read article: Getting Started article, especially the section Making a sample API call and the 3 notes in the screenshot.

How did we do?

Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)