As of October 1, 2020, Scholar Snapp Central API functionality is hosted by the College Board. See the College Board Website for details.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This section contains general troubleshooting information and some FAQs to aid client system developers and integration technologists working with Scholar Snapp.

General Troubleshooting Steps

If you're having issues connecting with the Scholar Snapp Central API, we recommend these general troubleshooting steps:

Additional detail follows.

Step 1. Confirm that your API credentials (i.e., the client key and secret) are correct for the API environment with which you're connecting

Scholar Snapp always assigns different credentials for our test and production environments, so ensure that the credentials you're using are intended for use with the environment to which you're trying to connect.

The base URLs for our environments are:

  • Test Environment: https://scholarsnapp-oauth-staging/
  • Production Environment: https://auth.scholarsnapp.org/

Step 2. Confirm that the Redirect URI is correct for the API credentials you're using

The Redirect URI is a value your organization provides. It tells us "where" to send the OAuth Bearer Token once the Snapp user has given permissions to your application. This value is bound to a specific key and secret pair — so if your environment has changed, we'll need to update the Redirect URI on our end. 

Your Redirect URI MUST be a secure (i.e., https://) connection in production. The Redirect URI MAY be via standard http: in test. 

Step 3. Confirm that the Snapp Profile XML your client system is sending to Snapp passes XSD validation

The vast majority of issues we see in test and production are resolved by simply ensuring that the XML data payload being sent is aligned with the Snapp XSD specification. There are many fine XML validation tools for most developer platforms and code frameworks. So, even if XML validation is not part of your current development process, there are many inexpensive and easy to use tools out there

The Snapp XSD for v4.0 can be found here, along with some sample XML files that validate against the specification.

It's worth noting that our system will attempt to extract information from an invalid XML file. But, this only works for a limited set of known errors and elements, so it's best to ensure that the data being sent by your client system adheres to the specification.

Frequently Asked Questions

Here are a few frequently asked questions related to troubleshooting:

Additional detail follows.

Credential Questions

Will Snapp issue OAuth credentials for a development machine?

Yes. We only issue developer credentials for our test environment, of course, but we're happy to do it.  

We want to test the Production environment connection using our staging system. Can you set a temporary OAuth Redirect URI for us?

Yes.


  • No labels