Using cURL
The examples within this document use cURL to demonstrate how to access the Clinical Genomic API.
Installing cURL
To connect securely to the server, you must install a version of cURL that supports SSL and provide an SSL certificate authority (CA) certificate file or bundle to authenticate against the Verisign CA certificate.
-
In your browser, navigate to the cURL home page at http://curl.haxx.se and click Download in the left navigation menu.
-
On the cURL Releases and Downloads page, locate the SSL-enabled version of the cURL software that corresponds to your operating system, click the link to download the ZIP file, and install the software.
-
Navigate to the cURL CA Certs page at http://curl.haxx.se/docs/caextract.html and download the ca-bundle.crt SSL CA certificate bundle in the folder where you installed cURL.
-
Open a command window, navigate to the directory where you installed cURL, and set the cURL environment variable,
CURL_CA_BUNDLE
, to the location of an SSL certificate authority (CA) certificate bundle. For example:C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt
You are now ready to send requests to CG APIs using cURL.
cURL Access
To use cURL to access the Clinical Genomic APIs:
-
Install cURL, as described above.
-
In a command window, set the cURL environment variable,
CURL_CA_BUNDLE
, to the location of your local CA certificate bundle. For information about CA certificate verification using cURL, see: http://curl.haxx.se/docs/sslcerts.html. -
Invoke cURL and specify one or more of the command-line options defined in the following table, as required, to direct its execution
cURL Option Description -d, --data @file.json
Identifies the request document, in JSON format, on the local machine. -F, --form @file.json
Identifies form data, in JSON format, on the local machine. -H
Defines one or both of the following: -
Content type of the request document
-
Custom header,
X-ID-TENANT-NAME
, to identify the identity domain
-i
Displays response header information. -u, --user username:password
Specifies the user name and password for the <ProductName> account. -X
Indicates the type of request (for example, GET, POST, and so on). -
For example:
curl -i -X GET -u <username>:<password> -H <request-header>:<value> https://<subdomain>.<domain>.com/<path>/<resource-path>