API client getting started

Prerequisites

Follow the instructions in Getting started with the AQtive Guard API for obtaining the API key.

Use the API key

There are two ways to pass your key to the API client:

• put it in an environment variable before using the client:
  Bash

  $ export CRYPTOSENSE_API_KEY=secret
  $ ./cs-api ...
  

• or pass it using the command-line option -k:
  Bash

  $ ./cs-api (...) -k secret (...)
  

Note

If both methods are used, the command-line option will take precedence.