Authentication

WindBorne uses API keys to authenticate API requests. If an API request is not properly authenticated, it will fail. To get a paid all access API key, email data@windbornesystems.com.

You should have an WB_API_KEY and a WB_CLIENT_ID . Conceptually, you can think of them as a username and password. You should make sure to keep your API key safe and secure.

To authenticate, pass HTTP basic auth headers in the GET request with username WB_CLIENT_ID and password WB_API_KEY . This follows RFC 7617; ie, as is standard, the credentials are colon-separated then base-64 encoded; many HTTP libraries will do this for you.

Basic Authentication

HTTP Basic Authentication Examples

# Make a GET request to WindBorne, authorizing with WindBorne correctly# Make a GET request to WindBorne, authorizing with WindBorne correctly

curl -u 'WB_CLIENT_ID:WB_API_KEY' 'URL'curl -u 'WB_CLIENT_ID:WB_API_KEY' 'URL'

Authentication Endpoint

To verify your credentials quickly, request /debug/v1/auth_status . On success it returns:

{{

"authed": true, "authed": true,

"client_id": "CLIENT_ID" "client_id": "CLIENT_ID"

}}

CLI and Installation

WindBorne releases a pip installable library built to interact with Data and Forecasts APIs that comes with a Command Line Interface (CLI) out of the box.

Install WindBorne

pip3 install windbornepip3 install windborne

Set credentials on mac and linux

Setup Environment Variables

# Determine your shell and it's configuration file# Determine your shell and it's configuration file

# Some common configuration files are: ~/.bashrc, ~/.bash_profile, ~/.zshrc# Some common configuration files are: ~/.bashrc, ~/.bash_profile, ~/.zshrc

echo $SHELLecho $SHELL

# Edit your shell configuration file adding these two lines# Edit your shell configuration file adding these two lines

export WB_CLIENT_ID='your_client_id'export WB_CLIENT_ID='your_client_id'

export WB_API_KEY='your_api_key'export WB_API_KEY='your_api_key'

# Reload the shell configuration to apply changes immediately or restart# Reload the shell configuration to apply changes immediately or restart

Set credentials on Windows

Press Win + X and select "System"
Click "Advanced system settings" on the right
Click "Environment Variables" at the bottom
Under "User variables", click "New" and add the following:

Variable Name	Variable Value
WB_CLIENT_ID	your_client_id
WB_API_KEY	your_api_key