The LEAP Developer Console, in conjunction with the LEAP API Gateway allows for an easy to build partner integration.
Integrating with LEAP has the power to add huge value for your users, streamlining their business processes and providing a great, nativelike experience.
In this guide, we’ll cover the key steps of building a great integration, including:
- Connecting and authenticating your users via LEAP Auth
- Creating a new LEAP App
- Gaining access to our API Reference
Creating a LEAP App
Any provider wishing to have a seamless LEAP integration needs to register a new LEAP Developer Console account.
The registration process allows you to gain access to, and start using the LEAP Developer Console.
To begin, register a new account by navigating to the LEAP Developer Console homepage and clicking on "Register". At this point we recommend that you take a moment to familiarize yourself with our Terms and conditions.
During the registration process, you'll be prompted to complete some partner details.Note that all fields marked with an asterisk are mandatory.
Once complete, you'll receive a confirmation email (to the registered email address).
If you have not received this email, please check your spam catchment folder.
Follow the link at the bottom of the email to complete the registration process.
A LEAP app is a term used for nativelike looking integrations. The following LEAP integrations are currently suppported:
- Simple button
- Drop-down button
- Context menu item (cards and documents)
- Global menu items
To get started, you need to create an "app" in the sandbox environment, which represents your partner integration. You’ll be issued with a client Id, client secret and an API Key, which will be used for generating bearer tokens, used for identity and authentication when making service requests.
To create a new app, click the "New App" button located in the top right of the home page.
You'll then be required to provide the following information:
- App details
- Marketplace information
- Location details (where in LEAP you'd like the app to appear)
Once you've added the required information, you'll be able to download the related config file, for local testing.
In order to test your app, you'll need a LEAP Sandbox environment.To get started, click the "New Credentials" button, located in the top right of the LEAP Accounts page.
Creating LEAP Credentials
When creating new credentials, you'll be prompted with the following options;
- LEAP Staging Sandbox (LEAP Test environment)
- LEAP Sandbox (LEAP Live environment)
The credentials you create here will be used to sign into LEAP Desktop.
From here, you'll be able to manipulate the LEAP account details as needed.
Clicking the cog next to your account will display the associated LEAP Firm, User and Staff Ids.
Before submitting your app for review, the first step is to submit it for pre-approval. To uphold the standards of quality and reliability that our customers expect, all publicly listed apps are subject to a pre-approval process. Select the app you wish to get pre-approved and navigate to the "Pre-Approval" option from the left hand menu.
Once you've met the pre-approval criteria, click the "New Approval" button, located in the top right of the page. Select the version you wish to submit from the dropdown menu and attach any supporting documents.
In order to access any LEAP API Gateway service, you're required to first generate a new set of LEAP Auth credentials.
To generate these credentials, select your app, the "Security" menu and then click "Generate Access Client".
Select the service(s) you want access to and then click "Save". NOTE: This service list is updated on ad-hoc basis.
Once complete, you'll receive a unique client Id and client secret with the requested security access.
Testing your App
The LEAP Developer Console provides a seamless testing mechanism for your app, by allowing you to test from a locally installed copy of LEAP. This not only allows for quicker development but decreases the time needed for internal quality assurance.
Once you've successfully setup a valid set of LEAP credentials, you would need to download and install a local copy of LEAP. This can be achived by navigating to the LEAP Account page and clicking on the "Download" button. Choose the region you wish to download for and simply follow the installation wizzard that follows.
Working on multiple regions
Another great advantage of the LEAP Developer Console, is that it allows you to create a LEAP App for mulitple regions. LEAP supports the testing of this, by providing functionality which allows you to switch regions.
To switch the region, open LEAP and whilst holding Ctrl+Alt+Shift click on the area shown below. Enter your valid set of credentials and login.
Before testing your app, it's recommended that you enable LEAP debugging. To do this, login to LEAP and enable the built-in debugging mode by holding Ctrl and left clicking the white question mark, located on the top right of the page.
This will display a window, requesting a password. Enter 'offex' followed by today's date. For example, on the 4th of March, the password would be 'offex4'.
The "Debug and Error Log List" view, will display all API calls being made from LEAP. Access your app whilst this window is open to view the requests made to your callback URL.
Importing your app for local testing
Open LEAP and browse to the debug menu (shown above). Navigate to "Apps" and select 'Use a Local File for Matter Apps Configuration'.
Browse to and select the config file downloaded earlier (from the Apps page). Your app should then appear within LEAP, at the location specified in the configuration.
Once you’ve fully tested your integration in the sandbox, you’re ready to go live and can submit your app for approval.
To begin, click the three dots next to your app version and "Submit for Review".
Please describe the primary features / changes for the app and submit a step by step user guide for testing.
Any requests for review that don't contain a valid user guide, may be immediately rejected.
This page allows you to edit your LEAP Developer Console account details, such as:
- Company name, address and social presense.
- Editing, adding and removing your LEAP Developer Console users
For additional information on editing your sandbox LEAP account users, please view the LEAP Accounts section.