Overview - Permitech

TypeScript SDK

The Permitech TypeScript SDK on npm.

TypeScript SDK GitHub repo

The GitHub repo for the Permitech TypeScript SDK.

Note: This library is in pre-release mode and may not be stable.

Installation

npm install permitech

yarn add permitech

pnpm add permitech

Initialization/Authentication

You can configure Permitech using environment variables:

# Your Permitech API key
PERMITECH_API_KEY="your-permitech-api-key"

# Your Permitech project name
PERMITECH_PROJECT="your-permitech-project-name"

# The name of the Log stream you want to use for logging
PERMITECH_LOG_STREAM="your-permitech-log-stream "

# Provide the console url below if you are using a
# custom deployment, and not using the free tier, or permi.tech.
# This will look something like “console.permitech.yourcompany.com”.
# PERMITECH_CONSOLE_URL="your-permitech-console-url"

If you are using the free version of Permitech, there is no need to set the PERMITECH_CONSOLE_URL environment variable.

In Node.js, you can use process.env to specify these variables:

process.env.PERMITECH_API_KEY = "your-api-key";
process.env.PERMITECH_PROJECT = "your-project";
process.env.PERMITECH_LOG_STREAM = "your-log-stream";
process.env.PERMITECH_CONSOLE_URL = "your-console-url";

⌘I

TypeScript SDK

TypeScript SDK GitHub repo

​Installation

​Initialization/Authentication

Installation

Initialization/Authentication