1. Help Center
  2. Integrate with Accredible

API and Integration FAQs

You have questions, we have answers!

Do You Have API Documentation?

Yes, you can check it out here.


Does Accredible Use LTI?

Learning Tools Interoperability (LTI) is an education technology specification. It's a toolset that is used to create integrations with learning platforms. 

Yes, both our Brightspace and Canvas plugins were created using LTI. 


Do I Need a Premium Account To Set Up Integrations?

All of our Plans come with API Key access. The API Key is all you need from Accredible to set up an integration, manage authentication, and issue credentials.



How Can I Test Our Custom Integration Before Launch?

Where possible, we would recommend utilizing an Accredible Sandbox. When developing the integration on your sandbox platform, simply use the Accredible Sandbox API key.

Please note sandbox accounts are available for customers on our Plus and Premium Plans only. For more information, check out this article: How Do I Obtain and Use a Sandbox Account?

Alternatively,  you can conduct testing on your production account by issuing credentials to test or internal emails. To add a temporary layer of quality assurance, you could create credentials without publishing them.

You will find the relevant setting in your account by doing the following:

  1. Click on your name in the top right-hand corner of the Accredible dashboard.
  2. Click 'Settings'.
  3. Click 'API Management'.
  4. Untick 'Automatically publish Credentials created via the API.
  5. Press 'Save'.

We recommend re-enabling this setting once testing is complete, or you will need to manually publish credentials to your recipients. 


Does the API Documentation Apply to Sandbox Accounts?

Yes. However, the URL used in your API requests will need to include the domain 'sandbox.api.accredible.com'.


Can I Grant Team Members Access to API Keys?

'Use the API and manage API integrations' is a permission level granted to Administrators only. For information on how to add an Administrator to your account, check out this article: How Do I Add Administrators?


Can I Use The Same API Key for Multiple Integrations?

Yes. You can use the same API Key as many times as desired! However, you can also create new API Keys for every integration, if prefered. 


Can We Set Up Different Integrations per Department?


Yes, organizations can set up multiple integrations with different keys. This makes it easy to keep track of access and easily provision new keys for ease of management. 

How Can I Generate a New API Key?

Issuers can create and manage two types of API key in their account, 'Account-wide' or 'Department-Specific'. Here is how: 

  1. Click on your name in the top right-hand corner of the Accredible dashboard.
  2. Click 'Settings'.
  3. Press 'API Management'.
  4. Select 'Manage API Keys'.
  5. Click 'Add API Key'. 
  6. Give the API Key a name and choose your desired permission level.
  7. Hit 'Save'. 

Important Note: Only customers on our Plus and Premium Plans will see the option to create a 'Department-Specific' API Key. 

 


Has this article helped you? Let us know!

If you would like to tell us about any improvements you feel could be made to this page, you can email us at support@accredible.com.