Integrate with Accredible
      Back to home
      1. Help Center
      2. Integrate with Accredible

      API and Integration FAQs

      You have questions, we have answers!

      Do You Have API Documentation?
      Does Accredible Use LTI?
      Do I Need a Premium Account To Set Up Integrations?
      What Do I Need To Manage an Integration on a Clients Behalf?
      How Can I Test Our Custom Integration Before Launch?
      What is the API Request URL for Sandbox and EU accounts?
      Can I Grant Team Members Access to API Keys?
      Can I Use The Same API Key for Multiple Integrations?
      Can We Set Up Different Integrations per Department?
      How Can I Generate a New API Key?
      Do I Need the Pro Plan To Use the Zoom Integration?

      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 Growth Account To Set Up Integrations?

      All of our Plans come with API Key access. However, the Kryterion, D2L Brightspace, and Microsoft Azure integrations require a Connect Accredible account.

      What Do I Need To Manage an Integration on a Clients Behalf?

      The API Key is all you need from Accredible to set up the integration, manage authentication, and issue credentials for a client.


      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 Connect and Growth 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. Select 'General Settings' from the side menu.
      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. 


      How Can I Populate a Group's Name and Description Through API?

      To populate a group's information directly via API, follow the instructions below:

      1. Click on Group at the top left-hand corner of the Accredible account.
      2. On the group you want to work on, click 'Group Settings'.
      3. Select 'Advanced Settings' then 'API & Integration' from the side menu.
      4. Turn ON/OFF 'Create these credentials via API'.
      5. Press 'Save'.

       

      Important Note: 

      When you enable these API settings, our system requires you to remove the Group Name and Description from the Info&Appearance section of your group in order for your API to populate this information automatically (If you don't leave the Name and Description fields blank, anything you create via API will pull the Group Name and Description directly from the Group Settings).
      If you want to disable these settings, remember to enter the Group Name and Description back in before turning the option off. If you try to turn it off while these fields are empty in the Info&Appearance section, the Group won't be recognized, and the system won't allow you to turn off the option. 

      What is the API Request URL for Sandbox and EU accounts?

      The URL used in your API requests will need to include the domain 'sandbox.api.accredible.com' for Sandbox accounts, and 'eu.api.accredible.com' for EU accounts.

      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 preferred. 

      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. Select 'General Settings' from the left-hand side menu. 
      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'. 

      Accredible Support 2022-12-22 at 09.39.38

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

      Do I Need the Pro Plan To Use the Zoom Integration?


      Yes. A paid Zoom plan is required for integration.

      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.