Introduction

For information on what's new in version 5.2, go to Release notes in the System administrator section.

Pay close attention to the information on this page. Some things need to be in place before you start incorporating Lequinox functionality in your application.

If your organisation has ordered a Lequinox compliance study, get acquainted with the use case that applies to your application and the functions required.

Please note that you need to be familiar with HTTPS, REST APIs, JSON responses, API key pairs and certificates.

With each release, we complete our API with new and updated request and response objects along with error messages. Make sure your application can handle or ignore unknown errors and response fields, and that it only processes the ones it is designed to receive. When your application receives an unknown error message, it should present a generic error message to the user.

Learn more about decentralisation, interoperability and the technology behind the Lequinox platform on www.lequanet.com.

1. Access sandbox

Before you can start testing your application towards the Lequinox platform, you need an organisation account on our sandbox environment, Lequania, for which you apply via email.

When you apply, please provide:

your company/organisation name,
your organisation number (that is, your national organisation ID),
your preferred name for the application (for test-purposes only),
an email address that you want to use for any administration purposes.

When your account is approved, you will receive:

an integration API key, needed for authentication in application calls towards the platform,
an application ID,
a server account ID.

Apply for an account here.

2. Understand the Lequinox concepts

In the Lequinox platform, there are a number of concepts you need to grasp to understand how various API functions fit together. We recommend that you browse these while waiting for your Lequania access, as they will help you understand how to implement Lequinox platform functionality in your application.

3. Browse some UI resources

You might want to provide your application user with a unified user experience as they come across UI content from the Lequinox platform in your application. You are welcome to use our action and status icons in your Lequinox-enabled application. You are free to adapt their colour scheme in accordance with the style guide that applies to your application.

4. Get started

When you are familiar with the concepts and your Sandbox account has been approved, you are all set to continue. Depending on your preferred approach, you have three options.:

Follow our tutorials, which focus on functions and API endpoints often required for an application to be able to utilise basic platform functions.
Refer directly to available functions, and implement the ones required in your application. For each function you are presented with useful steps and any error messages that might be returned if a method fails.
Refer directly to our REST API. This is only recommended if you have incorporated Lequinox platform functionality in applications before.

If you run into problems when you start out, please check our FAQ section.