Loading...
OpenAPI Directory | Cenit Admin

This API allows you to receive a feed of jobs from WorkBC's Job Board. Please see our data collection notice. Please note that you may experience issues when submitting requests to the delivery or test environment if using this [OpenAPI specification](https://github.com/bcgov/api-specs) in other API console viewers.

News API

This API is DriveBC's implementation of the Open511 specification. It provides information about known road events (traffic accidents, construction, etc.) in British Columbia, Canada. Please note that you may experience issues when submitting requests to the delivery or test environment if using this [OpenAPI specification](https://github.com/bcgov/api-specs) in other API console viewers.

Finds shortest/fastest route between a start point and one or more stop points on British Columbia's public road network. The BC Route planner [webpage](https://www2.gov.bc.ca/gov/content?id=9D99E684CCD042CD88FADC51E079B4B5) provides additional information. Here are some geocoded addresses to play with:
18 Douglas St,Victoria -123.36962,48.40892
1002 Johnson St, Victoria -123.355745,48.426206
543 Johnson St, Victoria, BC -123.36907,48.42770
14 Centennial Sq, Victoria, BC -123.36564,48.42863
1105 Royal Ave,New Westminster -122.92009,49.20063
808 Jackson Cres, New Westminster -122.90762,49.22558
10810 McDonald Rd, Chilliwack -121.93808,49.19859
3950 June Springs Rd, Kelowna -119.40751,49.83960
1201 Riondel Rd, Kootenay Bay -116.85402,49.74448
1201 Riondel Rd, Kootenay Bay -116.832759,49.730500 (parcelPoint)
2499 Walbran Pl, Courtenay -124.97295,49.71518
2013 Smoke Bluff Rd, Squamish -123.13946,49.70401
235 Kelvin Grove Way, Lions Bay -123.23524,49.45035
Please see our data collection notice. Please note that you may experience issues when submitting requests to the delivery or test environment if using this [OpenAPI specification](https://github.com/bcgov/api-specs) in other API console viewers. [Developer API keys](https://github.com/bcgov/gwa/wiki/Developer-Guide#developer-api-keys) are unique and provide the ability to make up to 2 requests per second. Production government applications may use organization API keys which are further described in [the Developer guide](https://github.com/bcgov/gwa/wiki/Developer-Guide#developer-api-keys). **To acquire an API key please visit the [API Key Request](https://kq.apps.gov.bc.ca) application.**

Common Features / Behaviors

  • * "sort" param: supports multi column sorting through the use of commas as delimiters, and a hyphen to denote descending order.
    Examples:
    • namesort results by name ascending
    • -namesort results by name descending
    • -name,idsort results by name descending and then by id ascending
    • id,-dateContentAuthoredsort results by id ascending and then date descending
  • Date formats: Date input format is expected to be based on RFC 3339.
    Example:
    • 2013-11-18T18:43:01Z

Definition of ISBNdb.com API

Land Registry Deed API

# 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://git@github.com/Lumminary/lumminary-api-client-python.git@v1.0.7#egg=lumminary-api-client ``` Or add the following line in your requirements.txt ```bash git+https://git@github.com/Lumminary/lumminary-api-client-python.git@v1.0.7#egg=lumminary-api-client ``` ## How to install the Lumminary Toolkit #### PHP example: The PHP Lumminary Toolkit is available at: https://github.com/Lumminary/lumminary-toolkit-php To install the Lumminary Toolkit, run the following command where 'lumminary-toolkit-directory' is the directory where you want to install the Lumminary Toolkit: `git clone git@github.com:Lumminary/lumminary-toolkit-php.git lumminary-toolkit-directory` #### PYTHON example: The Python Lumminary Toolkit is available at: https://github.com/Lumminary/lumminary-toolkit-python To install the Lumminary Toolkit, run the following command where 'lumminary-toolkit-directory' is the directory where you want to install the Lumminary Toolkit: ```bash git clone git@github.com:Lumminary/lumminary-toolkit-python.git lumminary-toolkit-directory cd lumminary-toolkit-directory virtualenv env source env/bin/activate pip install -r requirements.txt ``` Note that before running the toolkit, you should have the virtualenv enabled, like so : `source lumminary-toolkit-directory/env/bin/activate` ## Toolkit Setup We recommend to run the Toolkit in a cronjob; at every run it will check for new Authorizations (Orders) and will download them; afterwards it will check for a new reports folder inside the old authorizations, process the reports, and delete the processed Authorizations and Reports from your server. The first step after you clone the Lumminary Toolkit project for your language is to configure it with your credentials. Go to the Lumminary Toolkit base diretory `cd lumminary-toolkit-directory`. Under the Toolkit directory, you will find a file `config/config_template.json` which has the following structure: ```json { "api_key": , "product_uuid": , "api_host": "https:\/\/api.lumminary.com\/v1", "output_root": , "export_handler": , "product_name": , "operations": [ "pull_datasets", "push_reports" ], "optional": { "dna_data_filename": "dna-data.tsv", "authorization_metadata_filename": "authorization-metadata.json" } } ``` You should copy this config `cp config/config_template.json config/my-product1-config.json` then edit it `vim config/my-product1-config.json` to contain the following values: | Config attribute | Example Value | Description | |------------------|------------------------------------|-------------| | api_key | `"TiiU...bqg=="` |Your Lumminary API key.
You can obtain it from the Lumminary Admin | | product_uuid | `"1234-1234-1234-1234"` |Your product UUID. This value can be obtained from the Lumminary Admin | | api_host | `"https:\/\/api.lumminary.com\/v1"` | The API endpoint to use.
For the sandbox environment you can use "https:\/\/sandbox-api.lumminary.com\/v1" | | output_root | `"/var/lumminary-orders/product1/"` | The base directory where the Toolkit places the Authorizations for your Product
The Lumminary Toolkit will *never* overwrite Authorization data or create this directory, to protect from overwrites or typos | | export_handler |`"export_handler_tsv"` | If you have a custom export handler, then your Lumminary contact will provide you with the name of your export handler. | | operations |`["pull_datasets", "push_reports"]` | These are two optional parameters that define the tasks that the Toolkit should perform. Possible values are:
1. `pull_datasets` - this tells the Toolkit to download the Customer Authorization (Customer details and genetic data)
2. `push_reports` - this tells the Toolkit to push the results to the API; see below for more details| | optional | `{}` | Export handler specific value | After updating the config file for your Toolkit, it should look similar to (Note that these are all dummy values) : ```json { "api_key": "TiiU...bqg==", "product_uuid": "1234-1234-1234-1234", "api_host": "https:\/\/api.lumminary.com\/v1", "output_root": "\/var\/lumminary-orders\/product1\/", "export_handler": "export_handler_tsv", "product_name": "product 1", "operations": [ "pull_datasets", "push_reports" ], "optional": { "dna_data_filename": "dna-data.tsv", "authorization_metadata_filename": "authorization-metadata.json" } } ``` You can now save and exit the text editor `:wq` and start polling the API for new Authorizations : Python ```bash # While still in the directory source env/bin/activate; python lumminary_partner_toolkit.py --config-path config/my-lumminary-product1-config.json ``` PHP ```bash # While still in the directory php lumminary-partner-toolkit.php --config-path config/my-lumminary-product1-config.json ``` When your Product receives new Authorizations, the Toolkit will pull all the relevant data and save it in the following files: ```bash # The DNA data file. Format compatible with 23AndMe by default //dna-data.tsv # The Authorization metadata //authorization.json ``` The contents of the files pulled when processing an Authorization are as follows: ```bash $ head -n 5 //dna-data.tsv # rsid chromosome position genotype rs12070387 1 6267531 CC rs149124387 1 12025561 CC rs116458387 1 14920119 AA rs4436387 1 15498452 CC $ cat //authorization.json { "authorization": , "created_timestamp_utc": 1542920184, "customer": , "customer_address": { "address1": , "address2": , "city": , "country": , "state": , "zipcode": }, "customer_email": , "customer_name": { "first_name": , "last_name": }, "dataset": , "product": } ``` After the Toolkit downloaded the Authorizations, you need to process the Customer genetic data file and the Customer details, individually. The Lumminary API supports multiple types of products: | Scenario | How to Report | |------------------|------------------------------------| |The product is a file (.pdf, .jpeg etc.) | Put the result file(s) into the `tmp_reports` directory. Please refer to the Note underneath this table. | |The product requires authentication | Create a file with the name `result.json` into the `tmp_reports` directory, with the following content:
`{ "credentials": { "username": "username@example.com", "password": "your generated password", "url": "https://your-website.com/report"}}`
The `url` should point to a login page that upon authentication redirects the user to the report page. You can find the customer's email address in the `authorization-metadata.json` and the `password` attribute must be a secure password. Please refer to the Note underneath this table. | |The product is a physical product| Create a file with the name `result.json` into the `tmp_reports` directory, with the following content:
`{"physical_product": { "physical_product_completed": true }}`
This should be done upon dispatch. Please refer to the Note underneath this table. | |An error occurred| Create a file with the name `result.json` into the `tmp_reports` directory, with the following content:
`{ "unfulfillable": {"error": "Reasons for why it is unfulfillable", }}`
The error message is for Lumminary internal usage, and it won't be visible to the customer. This will delete your Authorization, making it unuseable thereafter. So please use this only for unfixable errors, and never for temporary errors you attempt to resolve. Please refer to the Note underneath this table. | ###### Note For each scenario above, we recommend you use a temporary directory to avoid uploading incomplete files or reports. So your workflow should be: * create a temporary directory inside the `/`, such as `//tmp_reports/` * place your result file(s) in the `tmp_reports` directory (as in the above table) * rename the directory from `tmp_reports` to `reports` We recommend running the Toolkit in a cronjob, wrapped by some locking mechanism. Also, Toolkit logs are very minimal but can be very helpful when debugging an issue, so please consider saving them to a file. For example, the following cronjob runs the Toolkit every minute: ```bash # Open the crontab crontab -e ``` PHP Toolkit ```bash # Add the following line (replace with the absolute path of the Lumminary Toolkit) * * * * * flock /var/lock/lumminary-toolkit.lock php /lumminary-partner-toolkit.php --config-path /config/my-product1-config.json >> /var/log/lumminary-toolkit.log ``` Python Toolkit ```bash # Add the following line (replace with the absolute path of the Lumminary Toolkit) * * * * * flock /var/lock/lumminary-toolkit.lock source env/bin/activate; python /lumminary_partner_toolkit.py --config-path /config/my-product1-config.json ``` ## API endpoints Lumminary provides two endpoint APIs, sandbox and production. You can use the sandbox for your integration and testing, simulate orders, upload genetic data, and generate reports. The sandbox works exactly like the production environment, and you can test your end-to-end integration. In order to simulate a complete order, you need to use this test credit card: |Credit card number | Expiration date| CVV2| |--------------------|----------------|-----| |4242 4242 4242 4242 | 12/30 | 123 | ### Sandbox website: [sandbox-www.lumminary.com](https://sandbox-www.lumminary.com) api-hostname: [sandbox-api.lumminary.com/v1](https://sandbox-api.lumminary.com/v1) ### Production website: [lumminary.com](https://lummianary.com) api-hostname: [api.lumminary.com/v1](https://api.lumminary.com/v1) # Obtaining credentials To obtain credentials, you need to register as a Lumminary partner. You can do this by [filling in this form](https://lumminary.com/register-for-connect-with-lumminary). You will then receive the following: |Credentials|Description| |-------|-------| |Product UUID|Each product you register on the Lumminary platform gets an UUID which will be used to identify that product to the Lumminary API| |API key|The secret API key associated with the Product UUID| |Partner UUID|Upon your first registration on the Lumminary platform, you will receive a single Partner UUID, which identifies you as one entity, regardless of product. This identifier is used for the Connect with Lumminary (CWL) functionality.| |CWL Encryption Key|The CWL encryption key is associated with the Partner UUID and is used to encrypt all communication for the Connect with Lumminary functionality.| Each product or service needs to have its own product UUID and API key, which means you have to fill in the form for all products and services that require access to Lumminary customer data. ## Configure the credentials to the Lumminary API Client The easiest way to set up your credentials is to use an environment file. For this, you must create a file named `env.json` (but any name will do) in your project directory, which should contain: ```json { "product_uuid": , "api_key": , "role": "role_product", "api_host": } ``` In order to load the Credentials from the `env.json`, you can use the following code: #### PHP example: ```php require_once(__DIR__."/vendor/autoload.php"); $credentials = new Lumminary\Client\Credentials(); $credentials->loadJSONCredentials(__DIR__."/env.json"); ``` #### Python example: ```python import lumminary_sdk as lumminary import os credentials = lumminary.Credentials() credentials.load_json_credentials( os.path.join( os.getcwd(), "env.json" ) ) ``` ## Alternative credentials configuration You also have the option of passing the credentials as constructor parameters when instantiating the `Credentials` class. #### PHP example: ```php require_once(__DIR__."/vendor/autoload.php"); $credentials = new Lumminary\Client\Credentials( , , ); ``` #### Python example: ```python import lumminary_sdk as lumminary credentials = lumminary.Credentials( product_uuid = , api_key = , api_host = , role = "role_product" ) ``` ## Create an API instance With the credentials configured and loaded, you can create an API client like so : #### PHP example ```php $apiClient = new Lumminary\Client\ApiClient($credentials); ``` #### Python example ```python apiClient = lumminary.LumminaryApi(credentials) ``` # Query customers authorizations An Authorization represents permission from a client to access their personal and genetic data. There are 2 situations where customers grant you access to their data: * when a customer buys your product from the Lumminary DNA App Store * when a customer clicks on the "Connect with Lumminary" button on your website Each time either of the above situations happens, our platform creates an Authorization UUID. You can reliably assume that if you have an Authorization UUID, you automatically have access to all the personal information and genetic data needed by your products and services. After you process an Authorization you need to mark it as processed; processed Authorizations will no longer be on the list of new authorizations. There are two ways to obtain the Authorization UUID: * _polling_ - this method allows you to periodically interrogate our API and pulls the list of Authorization UUIDs. * _webhooks_ (coming soon) - this method allows our API to push the Authorization UUIDs into your platform. ## Poll method To use the polling method, your servers periodically interrogate for new Authorization UUIDs. Please keep in mind that Authorizations not marked as processed will always be returned when polling for new Authorizations. This means there's a risk of parallel processing the same Authorization. To avoid this, you can, for example, consider using locking when processing. #### A PHP example of using the polling API looks like: ```php $productAuthorizations = $apiClient->getAuthorizationsQueue( $apiClient->getCredentials()->getProductUuid(), ); foreach($productAuthorizations as $productAuthorization) { /** * Add your code for processing customer data here **/ // Mark Authorization as processed $apiClient->postProductAuthorization( $productAuthorization["productUuid"], $productAuthorization["authorizationUuid"] ); } ``` #### A Python example of using the polling API looks like: ```python productAuthorizations = apiClient.get_authorizations_queue( apiClient.get_credentials().product_uuid ) for productAuthorization in productAuthorizations: ####### # Add your code for processing customer data here ####### # Mark Authorization as processed apiClient.post_product_authorization( productAuthorization.product_uuid, productAuthorization.authorization_uuid ) ``` Based on the Authorization object obtained previously, we can now query the customer's information (personal details and genetic data). #### PHP example: ```php $authorizationMetadata = $apiClient->authorizationMetadata($productAuthorization["authorizationUuid"]); ``` #### Python example: ```python authorizationMetadata = apiClient.authorization_metadata(productAuthorization.authorization_uuid) ``` #### authorizationMetadata object object structure | Attribute name | Description | |:-------------------------:|:-------------------------------------------------------------------------------------------| | `customer` | The UUID of the customer granting the Authorization | | `product` | The UUID of the product that was authorized (your product UUID) | | `authorization` | The UUID of the granted Authorization. | | `created_timestamp_utc` | The unix timestamp in UTC time zone when the customer granted the Authorization | | `dataset` | (present only if requested) The UUID of the dataset authorized by the customer | | `customer_email` | (present only if requested) Customer contact email | | `customer_name` | (present only if requested) Customer name | | `customer_address` | (present only if requested) Customer address | By *present only if requested* we mean this attribute will be returned if at the time of configuring either the "Connect with Lumminary" button or your product, you have explicitly requested for that particular set of data. # Query customer genetic data Based on the Authorization object obtained previously, now we have authorizationMetadata which contains the customer's information (personal details and genetic data). Let's use this information to extract some customer genetic data. ## Get individual SNPs Out of all the available SNPs in the dataset, you can only access those for which the customer has previously granted permission. For example, fetching details for a particular SNP: #### PHP example: ```php $rsId = "rs114326054"; $snpDetails = null; // check to see if you have access to the customer genetic data if (isset($productAuthorization["scopes"]["dataset"])) { // get SNP information $snpDetails = $apiClient->getClientSnp( $productAuthorization["clientUuid"], $productAuthorization["scopes"]["dataset"], $rsId ); } ``` #### Python example: ```python rsId = "rs114326054" snpDetails = None # check to see if you have access to the customer genetic data if hasattr(productAuthorization.scopes, "dataset"): # get SNP information snpDetails = apiClient.get_client_snp( productAuthorization.client_uuid, productAuthorization.scopes.dataset, rsId ) ``` ##### The snpDetails object will contain these important attributes: | Attribute name PHP | Attribute name Python | Description | |:-------------------------:|:-------------------------:|:----------------------------------------------------------| | `snpId` | `snp_id` | The rsid of the SNP | | `referenceGenome` |`reference_genome` | The reference genome known to be used by the Dataset's source.
This impacts the reference allele, location, and based on the dbSNP build, also the SNP's accession | | `genotypedAlleles` | `genotyped_alleles` | The genotype value of the customer's queried SNP.

If the attribute of this SNP has the `phased` flag set to True,
the first items in the lists for all SNPs will be on the same inherited chromosome,
and analogous for the second item.

If the SNP is unphased, the order of the items is irrelevant | |`phased` | `phased` | A boolean. True if the SNP is known to be phased, False otherwise | |`chromosomeAccession` | `chromosome_accession` | This is the chromosome accession number where the SNP is located; in the format of NC_00x | |`location` | `location` | This is the customer's SNP's location on the chromosome | When trying to access any customer's SNP for which you don't have permission, an `Unauthorized` exception will be raised. ## Get all authorized SNPs The function below returns all SNPs your product has access to. These are all the SNPs configured as mandatory for your product, as well as all SNPs that are configured as optional and available in the customer's data set. We encourage you to use this option if you need to get all available SNPs, because it is faster than fetching SNP details one by one. For example, fetching all authorized SNPs: #### PHP example: ```php $datasetSnps = null; // check to see if you have access to the customer genetic data if (isset($productAuthorization["scopes"]["dataset"])) { // get all authorized SNPs $datasetSnps = $apiClient->getClientSnpGroup( $productAuthorization["clientUuid"], $productAuthorization["scopes"]["dataset"] ); } ``` #### Python example: ```python datasetSnps = None # check to see if you have access to the customer genetic data if hasattr(productAuthorization.scopes, "dataset"): # get all authorized SNPs datasetSnps = apiClient.get_client_snp_group( productAuthorization.client_uuid, productAuthorization.scopes.dataset ) ``` ##### The datasetSnps variable will be a list of objects each having the following attributes: | Attribute name PHP | Attribute name Python | Description | |:-------------------------:|:-------------------------:|:----------------------------------------------------------| | `snpId` | `snp_id` | The rsid of the SNP | | `referenceGenome` |`reference_genome` | The reference genome known to be used by the Dataset's source.
This impacts the reference allele, location, and based on the dbSNP build, also the SNP's accession | | `genotypedAlleles` | `genotyped_alleles` | The genotype value of the customer's queried SNP.

If the attribute of this SNP has the `phased` flag set to True,
the first items in the lists for all SNPs will be on the same inherited chromosome,
and analogous for the second item.

If the SNP is unphased, the order of the items is irrelevant | |`phased` | `phased` | A boolean. True if the SNP is known to be phased, False otherwise | |`chromosomeAccession` | `chromosome_accession` | This is the chromosome accession number where the SNP is located; in the format of NC_00x | |`location` | `location` | This is the customer's SNP's location on the chromosome | When trying to access any customer's SNP for which you don't have permission, an `Unauthorized` exception will be raised. ## Get Genes Along with individual SNPs, you can also get all the authorized SNPs from a particular gene, that are available in the customer's dataset. Here, by genes, we refer strictly to the genomic region that produces some protein, without considering regulatory or noncoding regions that influence gene expression. The gene name (known as symbol) can be from either of these two databases - NCBI and Ensembl. For example, fetching details for a gene symbol: #### PHP example ```php $geneSymbol = "C1ORF159"; $geneDetails = null; // check to see if you have access to the customer genetic data if (isset($productAuthorization["scopes"]["dataset"])) { // get all authorized SNPs within a gene $geneDetails = $apiClient->getClientGene( $productAuthorization["clientUuid"], $productAuthorization["scopes"]["dataset"], $geneSymbol ); } ``` #### Python example ```python geneSymbol = "C1ORF159" geneDetails = None # check to see if you have access to the customer genetic data if hasattr(productAuthorization.scopes, "dataset"): # get all authorized SNPs within a gene geneDetails = apiClient.get_client_gene( productAuthorization.client_uuid, productAuthorization.scopes.dataset, geneSymbol ) ``` ##### All the geneDetails object attributes are | Attribute name PHP | Attribute name Python | Description | |:---------------------:|:---------------------:|:-----------------------------------------------------------------------------------------| | `molecularLocation` | `molecular_location` | An object containing the location of the gene within the chromosome - see below the molecular location object structure | | `snps` | `snps` | A list of SNP objects present in the gene - see below the SNP object structure | | `symbol` | `symbol` | The gene's accession string (name) | ##### Molecular location attributes | Attribute name PHP | Attribute name Python | Description | |:-------------------------:|:---------------------:|:-----------------------------------------------------------------------------------------| | `chromosomeAccession` | `chromosome_accession` | The scaffold/chromosome on which the gene is placed | | `start` | `start` | The gene's start position on the scaffold | | `stop` | `stop` | The gene's stop position on the scaffold | ##### SNP object structure | Attribute name PHP | Attribute name Python | Description | |:-------------------------:|:---------------------:|:-----------------------------------------------------------------------------------------| | `referenceGenome` | `reference_genome` | The reference genome known to be used by the Dataset's source.
This impacts the reference allele, location, and based on the dbSNP build, also the SNP's accession| | `genotypedAlleles` | `genotyped_alleles` | The genotype value of the customer's queried SNP.

If the attribute of this SNP has the `phased` flag set to True,
the first items in the lists for all SNPs will be on the same inherited chromosome,
and analogous for the second item.

If the SNP is unphased, the order of the items is irrelevant | | `phased` | `phased` | A boolean. True if the SNP is known to be phased, False otherwise | | `chromosomeAccession` | `chromosome_accession` | This is the chromosome accession number where the SNP is located; in the format of NC_00x | | `location` | `location` | This is the customer's SNP's location on the chromosome | ## Get customer genetic data in 23andMe tsv format If your platform is already compatible with 23andMe genotype data files, you can use this specific function to generate data in the 23andMe format - list of rows in tab separated values. #### PHP example: ```PHP $authorizationDnaData = $apiClient->authorizationDnaData($productAuthorization["authorizationUuid"]); ``` #### Python example ```python authorizationDnaData = apiClient.authorization_dna_data(productAuthorization.authorization_uuid) ``` `authorizationDnaData` contains a list of rows in a tsv (tab delimited values)/csv format (23andme-compatible) # Submit reports After you finish analysing the customer's genetic data, we need to inform the customer their analysis is complete. To do this, you will notify us using the function below. Finally, the customer will then: * access their report file through a written electronic document (eg. .pdf or .doc) * access their report on your website under an account with a username and a password or * receive a physical product ## How to submit a report file When you submit such a report file, Lumminary will save this document into the customer's account, from which the customer will then be able to access it directly. #### PHP example ```php $pathToReportFile = ; $fileReport = new \SplFileObject($pathToReportFile); $friendlyFileName = "report_file_name"; //optional, give a friendly name to your report file $apiClient->postAuthorizationResultFile( $productAuthorization["productUuid"], $productAuthorization["authorizationUuid"], $fileReport, $friendlyFileName ); ``` #### Python example ```python pathToReport = originalFilename = "report_file_name" #optional, give a friendly name to your report file apiClient.post_authorization_result_file( productAuthorization.product_uuid, productAuthorization.authorization_uuid, pathToReport, originalFilename ) ``` If you need to upload multiple files, you have to call the function for each file, one at a time. ## How to submit a report so the customer can access it on your website If the customer's results can be accessed on your website, you will need to create a customer account on your platform, generating a user and password which will be sent through the Lumminary API into the customer's Lumminary account. In case you don't generate a user and a password for the customer to access their report, use the function below with "null" value to username and password. We recommend you use the URL for customer reports on a dedicated page for reports only, rather than your homepage or some other generic page. #### PHP example: ```php $apiClient->postAuthorizationResultCredentials( $productAuthorization["productUuid"], $productAuthorization["authorizationUuid"], , //optional, default null , //optional, default null // https://partnerwebsite.com/reports.php?reportid=a7508 ); ``` #### Python example: ```python apiClient.post_authorization_result_credentials( productAuthorization.product_uuid, productAuthorization.authorization_uuid, , # optional, default null , # optional, default null # https://partnerwebsite.com/reports.php?reportid=a7508 ) ``` ## How to submit a physical product In case you only send the customer a physical product and you don't generate any reports, you need to run the function below so we can mark the order as fulfilled and can inform the client. #### PHP example: ```php $apiClient->postProductAuthorization( $productAuthorization["productUuid"], $productAuthorization["authorizationUuid"] ); ``` #### Python example: ```python apiClient.post_product_authorization( productAuthorization.product_uuid, productAuthorization.authorization_uuid ) ``` # The Connect with Lumminary button The "Connect with Lumminary" functionality allows you to get customer details and genetic data from the Lumminary platform for free, anytime you want, for as long the customer grants you access. This functionality offers your customers the option to share their genetic data and other personal information (e.g. name, address, email etc.) stored on the Lumminary platform. Having this button on your website makes it very easy for the customer to share their genetic data with you, as they don't have to download and re-upload their data on your site. The customer always has the option to revoke your access to both their personal details and their genetic data. **`To protect the customer's privacy, you are not allowed to save their data anywhere. You can, however, always access their data on the Lumminary platform, for as long as they grant you access. If you generate a report based on customer data, you are allowed to save that report on your platform.`** In order to implement this functionality on your website, this is what you need to know: * Register your product on the Lumminary platform * Add the "Connect with Lumminary" button to your website * Configure your website to retrieve customer data * Possible errors ## Register your product on the Lumminary platform If you're new to the Lumminary platform and don't already have any products in the DNA App Store, then you need to register by [filling in this form](https://lumminary.com/register-for-connect-with-lumminary). You have to fill in the form for all products and services that require access to Lumminary customers' genetic data. ## Add the Connect with Lumminary button to your website Since the CWL flow involves encrypting and decrypting data, we recommend installing the Lumminary API Client, where you'll find some specific helper functions. In order to enable the button, you have to include the following script in the `` tag of all the pages where you want to enable the “Connect with Lumminary” button: ```html ``` The Javascript creates a CSRF token and attaches it to the button to be transmitted and verified on our servers each time a user clicks on the button. The CSRF token expires after 5 minutes. In case the CSRF token is expired or tampered, the user will be redirected to your website where it's up to you to decide what to do next - reload the page with the button or show the customer an error message. The `cwl.js` file is loaded as a deferred resource, which means that it will load after all the webpage code execution has been finished, so it will not have any impact on your website load speed. ### Chose a button colour There are two type of buttons, so you can pick one that matches your branding. The buttons are SVG images, which means that you can scale them up or down to fit your design, without compromising on image quality. You can do this by changing the image height. ##### a. White button version Lumminary DNA tests
```html Lumminary DNA tests ``` ##### b. Black button version Lumminary DNA tests
```html Lumminary DNA tests ``` ## Button configuration Each button has 2 attributes which need to be configured: 1. **data-partner-uuid** where you have to add your partner UUID (you have received the partner UUID after filling in the form for product registration). 2. **data-request** which is a string obtained by encrypting a serialized JSON (you have received the CWL encryption key after filling in the form for product registration). See details below. #### Data-request object The data-request object has a standard format which needs to be preserved. It is formed of two types of data, some mandatory and some optional. You can use the optional fields to add any metadata or other information for your own use. The data-request object is going to be returned with the response from the authentication without being altered. ##### Mandatory information The mandatory information is a list of scopes which you ask the client to grant permission for. These scopes are comma delimited, and the possible options are: `address`, `email`, `dataset`. The scopes _address_, _email_, and _dataset_ can be used in any combination; you must request at least one scope. | Attribute name | Description | |:-----------------:|:----------------------------------------------------| | `address` | Requests access to a customer's name and address. | | `email` | Requests access to a customer's email address. | | `dataset` | Requests access to a customer's genetic data | #### PHP example: ```php $objAuthorizationRequest ["scopes"] = "address,dataset,email"; ``` #### Python example: ```python objAuthorizationRequest ["scopes"] = "address,dataset,email" ``` Product UUID is your `productUuid` for which you ask customer permissions. #### PHP example: ```php $objAuthorizationRequest["productUuid"] = $credentials->getProductUuid(); ``` #### Python example: ```python objAuthorizationRequest["productUuid"] = credentials.product_uuid ``` ##### Optional information In the optional part of the object, you can add any useful data, such as customer ID, session ID, or any parameter which can help you identify the response from Lumminary. #### PHP example: ```php $objAuthorizationRequest["customData"] = array(); $objAuthorizationRequest["customData"]["customerId"] = ; $objAuthorizationRequest["customData"]["websiteSession"] = ; $objAuthorizationRequest["customData"]["customData3"] = ; ``` #### Python example: ```python objAuthorizationRequest["customData"] = {} objAuthorizationRequest["customData"]["customerId"] = objAuthorizationRequest["customData"]["websiteSession"] = objAuthorizationRequest["customData"]["customData3"] = ``` See below a complete example for a data-request object: #### PHP example: ```php $objAuthorizationRequest["scopes"] = "address,dataset,email"; $objAuthorizationRequest["productUuid"] = ; $objAuthorizationRequest["customData"] = array(); $objAuthorizationRequest["customData"]["customerId"] = ; $objAuthorizationRequest["customData"]["websiteSession"] = ; $objAuthorizationRequest["customData"]["customData3"] = ; ``` #### Python example: ```python objAuthorizationRequest = {} objAuthorizationRequest["scopes"] = "address,dataset,email" objAuthorizationRequest["productUuid"] = objAuthorizationRequest["customData"] = {} objAuthorizationRequest["customData"]["customerId"] = objAuthorizationRequest["customData"]["websiteSession"] = objAuthorizationRequest["customData"]["customData3"] = ``` ## Creating the Authorization Request The previously generated object (`objAuthorizationRequest`) will now need to be encrypted. In order to be able to encrypt the object and also query the Lumminary API to obtain the customer details and genetic data, you need to have the Lumminary API Client installed. If you haven't done this already, please follow these [steps](#Install-Lumminary-API-Client-andor-Toolkit). ### Add data-request attribute After you have the Lumminary API Client installed correctly you can use the command below: #### PHP example: ```php // You have recieved the CWL encryption key after filling in the form for product registration $partnerCwlKey = ; $requestValueEncryptedUrlEncoded = Lumminary\Client\LumminaryApi::cwl_data_request_build( $objAuthorizationRequest, $partnerCwlKey ); ``` #### Python example: ```python import lumminary_sdk as lumminary # You have recieved the CWL encryption key after filling in the form for product partnerCwlKey = requestValueEncryptedUrlEncoded = lumminary.LumminaryApi.cwl_data_request_build(objAuthorizationRequest, partnerCwlKey) ``` The resulting string should be added in the `data-request` attribute of the `` tag of the "Connect with Lumminary" button. ### Add data-partner-uuid attribute Add the `data-partner-uuid` in the `data-partner-uuid` attribute of the `` tag of the "Connect with Lumminary" button. You have received the partner UUID after filling in the form for product registration. An example of a button correctly configured should look like this: ```html Lumminary DNA tests ``` ## Connect with Lumminary summary of user interaction When a customer clicks on the “Connect with Lumminary” button, a pop-up window opens. After they choose which genetic file to share, the pop-up will automatically close and the user will be redirected to your callback URL in the parent window. Your callback URL needs to be predefined in the Lumminary partner portal. The GET request from the client to your callback URL will contain two querystring parameters - `request` and `response`: 1. `request` – this is exactly the same request that you previously sent in the `data-request` field. You can decrypt it with the CWL encryption key which you used to encrypt it. 2. `response` – the response is an urlencoded encrypted serialized JSON object which contains the Authorization UUID and the Authorization UTC unix timestamp. You will use the Authorization UUID to get the customer's data with the Lumminary API Client. The response string is encrypted with your CWL encryption key, the same as the `data-request` parameter. In order to decrypt the `response` parameter, you can use the following function: #### PHP example: ```php // the entire callback URL, including the querystring parameters $callbackUrlWithPayload = "https://partnerwebsite.con/callback?request=...&response=..."; $cwlReturnObject = Lumminary\Client\LumminaryApi::cwl_url_query_extract( $callbackUrlWithPayload, $partnerCwlKey ); ``` #### Python example: ```python // the entire callback URL, including the querystring parameters callback_url_with_payload = "https://partnerwebsite.con/callback?request=...&response=..." cwlReturnObject = apiClient.cwl_url_query_extract( callback_url_with_payload, partner_cwl_key ) ``` The `cwlReturnObject` will now contain an object like the example below: ```json { "request": , "response": { "authorizationUuid": , "authorizationTimestamp": } } ``` With the Authorization UUID (`authorizationUuid`) you can [query all the customer details](#Query-customer-genetic-data) from the Lumminary platform. ## Possible errors When an error occurs, the customer is redirected to your callback URL. The redirect contains two querystring parameters - `request` and `response` - exactly like a regular response, but the `response` parameter contains an error object (see below) instead of an Authorization object. #### PHP example: ```php // the entire callback url, including the querystring parameters $callbackUrlWithPayload = "https://partnerwebsite.con/callback?request=...&response=..."; $cwlReturnObject = Lumminary\Client\LumminaryApi::cwl_url_query_extract( $callbackUrlWithPayload, $partnerCwlKey ); ``` #### Python example: ```python # the entire callback url, including the querystring parameters callback_url_with_payload = "https://partnerwebsite.con/callback?request=...&response=..." cwlReturnObject = apiClient.cwl_url_query_extract( callback_url_with_payload, partner_cwl_key ) ``` Example of a return object (`cwlReturnObject`) containing an error message: ```json { "request": , "response": { "error": { "id": , "message": } } } ``` | 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) |

All about Numbers. REST access with json/xml/jsonp result support. Below is the documentation for the Numbers API. You can try them out right here. Find more information and subscribe at [math.tools](https://math.tools/api/numbers/)

The RGD REST API provides programmatic access to information and annotation stored in the Rat Genome Database

The destination for current and historic NBA statistics.

A web service for near earth objects. All the data is from the NASA JPL Asteroid team. NeoWs is proud to power AsteroidTracker on iOS and Android as well as related apps. Follow us on Twitter

The Buildings Database is a shared resource for the building industry. The Database, developed by the U.S. Department of Energy and the National Renewable Energy Laboratory (NREL), is a unique central repository of in-depth information and data on high-performance, green building projects across the United States and abroad.

Query our database of State and Federal Laws and Incentives for Alternative Fuels

This API allows programmers to build National Snow and Ice Data Center data and metadata services into their applications.

The Archive API provides lists of NYT articles by month going back to 1851. You can use it to build your own local database of NYT article metadata.

The Books API provides information about book reviews and The New York Times bestsellers lists.

89 api specs