SDKs and CLI

Client libraries and the CLI.

The API is plain HTTPS and JSON, so any HTTP client works. Open-source client libraries and a command line tool wrap the same endpoints with idiomatic, typed methods.

Install

LanguageCommand
Node.js / TypeScriptnpm i aveecare
Pythonpip install aveecare
Rustcargo add aveecare
Gogo get github.com/aveecare/aveecare-go
Rubygem install aveecare
PHPcomposer require aveecare/aveecare
Javacom.aveecare:aveecare-java
.NETdotnet add package AveeCare
Command linenpm i -g aveecare-cli

Configure

Pass your API key when you create the client. Reading it from an environment variable keeps it out of your source code.

Node.js
import AveeCare from 'aveecare';

const avee = new AveeCare({ apiKey: process.env.AVEECARE_API_KEY });
Python
import os
from aveecare import AveeCare

client = AveeCare(api_key=os.environ["AVEECARE_API_KEY"])

Code samples

Every endpoint reference page shows a request in cURL plus each language below. The language you choose is remembered across pages. If a language is missing on an endpoint, no sample exists for it yet.

  • cURL
  • Node
  • Python
  • Rust
  • Go
  • Ruby
  • PHP
  • Java
  • C#
  • CLI