Lumminary API API

Overview

# 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**](#section/Introduction/Overview) * [**Install Lumminary API Client and Toolkit**](#Install-Lumminary-API-Client-andor-Toolkit) * [**Obtaining credentials**](#Obtaining-credentials) * [**Query customers authorizations**](#Query-customers-authorizations) * [**Query customer genetic data**](#Query-customer-genetic-data) * [**Submit reports**](#Submit-reports) * [**"Connect with Lumminary" button**](#the-connect-with-lumminary-button) * [**API specs**](#tag/Lumminary) ## 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](https://getcomposer.org), you can import the project by adding the following to your `composer.json` ```json "repositories": [ { "type": "git", "url": "https://github.com/Lumminary/lumminary-api-client-php.git", "reference": "master" } ], "require": { "lumminary/api-client-php": "v1.0.6" } ``` Then run `composer update lumminary/api-client-php` #### Python example: The Python Lumminary API Client is available at: https://github.com/Lumminary/lumminary-api-client-python To install directly, run ```bash pip install git+https://[email protected]/Lumminary/[email protected]#egg=lumminary-api-client ``` Or add the following line in your req

Lumminary API is an open data API from lumminary.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 17 endpoints.

At a glance

Authentication

API key

HTTPS

Yes

CORS

Unknown

Category

Open Data

Base URL

https://api.lumminary.com/v1

Version

1.0

Endpoints

17

OpenAPI

Specification ↗

Spec updated

2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://api.lumminary.com/v1/reference/genomes/" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://api.lumminary.com/v1/reference/genomes/", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://api.lumminary.com/v1/reference/genomes/",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions