Mock sample for your project: GlobalWineScore API Documentation
Integrate with "GlobalWineScore API Documentation" from globalwinescore.com in no time with Mockoon's ready to use mock sample
GlobalWineScore API Documentation
globalwinescore.com
Version: 8234aab51481d37a30757d925b7f4221a659427e
Integrate third-party APIs faster by using "GlobalWineScore API Documentation" ready-to-use mock sample. Mocking this API will help you accelerate your development lifecycles and improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.
It also helps reduce your dependency on third-party APIs: no more accounts to create, API keys to provision, accesses to configure, unplanned downtime, etc.
Description
The GlobalWineScore API is designed as a RESTful API, providing several resources and methods depending on your usage plan.
For further information please refer to our plans.
Authentication
The API uses token-based authentication.
In order to authenticate your requests, you need to include a specific header in each of your requests:
The word Token must be written. Your requests must also use the HTTPS protocol.
If you don't have a token yet, you need to apply for one here.
Your personal token can be found under the My account > API section of the GlobalWineScore website
Format
The API provides several rendering formats which you can control using the Accept header or format query parameter.
JSON (default): no header or Accept: application/json
XML: Accept: application/xml
Rate limiting
For API requests, the rate limit allows for up to 10 requests per minute.
Error handling
Whether a request succeeded is indicated by the HTTP status code. A 2xx status code indicates success, whereas a 4xx status code indicates failure.
When a request fails, the response body is still JSON, but always contains a detail field with a description of the error, which you can inspect for debugging.
For example, trying to access the API without proper authentication will return code 403 along with the message:
{"detail": "Authentication credentials were not provided."}
Found a bug ? send us an email at [email protected]
Ordering
At the moment, GlobalWineScores may be sorted by date and score. Use "-"
to sort in descending order.
Continuous synchronization
If you need to synchronize your database with our API, you can query our API using ?ordering=-date to get the newest scores first, which means you won't have to crawl the whole catalog every time :-)
Quick search interface
If you need to search our catalog (e.g. to align it with yours), we're providing you with a handy interface accessible here: https://api.globalwinescore.com/search/
You need to be logged in (email/password) to access this page, but other than that you can share it with anyone in your team and start searching right away !
Resources
The details about available endpoints can be found below.
You can click on each endpoint to find information about their parameters.
Other APIs in the same category
Transport Department, Madhya Pradesh
Motor Vehicle Department, Odisha
Mtaa API Documentation
eNanoMapper database
Geographic API
High Performance Building Database
Lumminary API
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) |
CarbonDoomsDay
