Mock sample for your project: Lumminary API
Integrate with "Lumminary API" from lumminary.com in no time with Mockoon's ready to use mock sample
Lumminary API
lumminary.com
Version: 1.0
Speed up your application development by using "Lumminary API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
It also improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.
Description
Introduction
The Lumminary API was built to allow third parties to interact with Lumminary customers and gain access to their genetic data. The Lumminary API is fast, scalable and highly secure. All requests to the Lumminary API take place over SSL, which means all communication of Customer data is encrypted.
Before we dive in, some definitions. This is what we mean by:
|Term|Definition|
|-----------|-----------|
|Third party|A third party (also referred to as "partner" or as "you") is a company which offers services and products using genetic data.|
|Lumminary clients|The Lumminary client (also referred to as "customer") is an individual who has created an account on the Lumminary platform.|
|Lumminary|This is us - our services including the Lumminary platform, the API, the DNA App Store, the DNA Vault, the "Connect with Lumminary" button, and the website in its totality. |
|CWL|This is the acronym for the "Connect with Lumminary" button.|
|dataset|This is the term we use when we refer to a customer's genetic data.|
|Lumminary API|This is a library/module that you can use to integrate your apps with the Lumminary platform.|
|Lumminary toolkit|This is a stand alone application which helps you integrate with Lumminary without writing any code or interacting with the Lumminary API.|
Let's dive in, now.
Overview
Install Lumminary API Client and Toolkit
Obtaining credentials
Query customers authorizations
Query customer genetic data
Submit reports
"Connect with Lumminary" button
API specs
Overview
In order to use Lumminary services, you'll need to install the Lumminary API Client or Toolkit. The Lumminary API Client and Toolkit are available in multiple programming languages, and we also provide a sandbox environment which you can use for integration and tests.
There are a couple of differences between the API Client and the Toolkit. Mainly, it's about the ease of use for integration. The Toolkit is basically a stand-alone application that facilitates the integration with the Lumminary API without the need to modify your already existing code.
You use the Lumminary API Client when you want to integrate it inside your own application. This means it gives you full flexibility regarding the integration into your own workflow.
You use the Lumminary Toolkit for an integration where the Toolkit is placed alongside your own application. You can use the Toolkit from the CLI - for example, to run a cronjob that processes incoming orders. The Toolkit uses the Lumminary API Client.
Install Lumminary API Client and/or Toolkit
We provide the Lumminary API Client and Toolkit in multiple programming languages - default are PHP (minimum version 7.0), Python2.7 and Python3. However, if you need them in another language (Java, Obj-C, JavaScript, C#, Perl, CURL), please contact us.
How to install the Lumminary API Client
PHP example:
The PHP Lumminary API Client is available at: https://github.com/Lumminary/lumminary-api-client-php
If you are already using Composer, you can import the project by adding the following to your composer.json
| Error Id | Error Message |
|:-----------------:|:---------------------------------------------------------------------------------------------|
| 1 | Invalid Security Token |
| 2 | Invalid Access Scopes |
| 3 | Customer refuses your request (this happens when the customer cancels instead of granting access) |
Other APIs in the same category
The Oriental Insurance Co. Ltd.
Directorate of Economics and Statistics Cum Chief Registrar, Rajasthan, Rajasthan
Department of Food, Public Distribution & Consumer Affairs (PDS), Jharkhand
PGIMER, Chandigarh
Sailu Municipal Council, Maharashtra
Indian Navy (INS Valsura)
Andaman Law College, Andaman & Nicobar
TheTVDB API v3
How to use this API documentation
You may browse the API routes without authentication, but if you wish to send requests to the API and see response data, then you must authenticate.
Obtain a JWT token by POSTing to the /login route in the Authentication section with your API key and credentials.
Paste the JWT token from the response into the "JWT Token" field at the top of the page and click the 'Add Token' button.
You will now be able to use the remaining routes to send requests to the API and get a response.
Language Selection
Language selection is done via the Accept-Language header. At the moment, you may only pass one language abbreviation in the header at a time. Valid language abbreviations can be found at the /languages route..
Authentication
Authentication to use the API is similar to the How-to section above. Users must POST to the /login route with their API key and credentials in the following format in order to obtain a JWT token.
{"apikey":"APIKEY","username":"USERNAME","userkey":"USERKEY"}
Note that the username and key are ONLY required for the /user routes. The user's key is labled Account Identifier in the account section of the main site.
The token is then used in all subsequent requests by providing it in the Authorization header. The header will look like: Authorization: Bearer . Currently, the token expires after 24 hours. You can GET the /refresh_token route to extend that expiration date.
Versioning
You may request a different version of the API by including an Accept header in your request with the following format: Accept:application/vnd.thetvdb.v$VERSION. This documentation automatically uses the version seen at the top and bottom of the page.
Department of Registration & Stamps, Maharashtra
Paramedical Council, Madhya Pradesh
