KI BMS

Client libraries

Drop-in API wrappers for KI BMS in Python, TypeScript, JavaScript, Go, Java, Rust, C#, C++, PHP, Ruby, Kotlin, Swift, Dart, Elixir, and Clojure.

Each library is a single source file you download from this page and drop into your project. Most languages need nothing else - the file uses only the standard library. Rust is the one exception: add the two crates listed in the file header (reqwest + serde_json) to your Cargo.toml and you're done. Every endpoint the KI BMS HTTP API exposes is wrapped as a typed function named after the data model and operation, so the surface mirrors the REST API one-to-one. Authentication uses the same personal access tokens the rest of the API accepts. The libraries are easy to vendor, audit, and extend directly in your own codebase.

Download

Pick your language and download the single source file. Module name for KI BMS: ats_client. Class name for languages with an explicit wrapper type: AtsClient.

Version: 0.3.13·Module: ats_client·Models: 11
Per-language vendoring tips
  • PythonDrop ats_client.py into your package; from ats_client import .... Pure stdlib (urllib.request / json / threading); requires Python 3.8+.
  • TypeScriptDrop ats_client.ts next to your other TS files. Type-checks under any combination of @types/node + DOM lib via small built-in shims; runtime uses fetch (Node 18+ / browser).
  • GoPlace ats_client.go inside a directory named ats_client/ so the file's package ats_client declaration matches its import path.
  • JavaPlace AtsClient.java inside a directory named ats_client/ matching the file's package ats_client; declaration. Targets JDK 11+; uses java.net.http only.
  • RustAdd the file as a module (mod ats_client; in your lib.rs or main.rs) and add the two crates listed in the file header (reqwest with the blocking,json features, plus serde_json) to your Cargo.toml.
  • C# / .NETPlace AtsClient.cs in any folder; the file declares namespace ats_client;. Targets .NET 6+; uses HttpClient + System.Text.Json only - no NuGet packages.
  • PHPrequire_once __DIR__ . '/ats_client.php' from your bootstrap, or autoload the namespace ats_client\\ via Composer's PSR-4. Requires PHP 8.0+ with the curl and json extensions (both default).
  • Rubyrequire_relative 'ats_client' from anywhere in your project. The wrapper class is AtsClient::Client. Targets Ruby 3.0+; pure stdlib (net/http, json, securerandom).
  • KotlinPlace AtsClient.kt inside a directory named ats_client/ matching the file's package ats_client declaration. Targets Kotlin 1.9+ on JVM 11+; pure JDK only.
  • SwiftDrop AtsClient.swift next to your other Swift files. Targets Swift 5.7+ (macOS 12 / iOS 15 / Linux with FoundationNetworking).

Authenticate

Create a personal access token (PAT) from the Integrations menu and pass it to the library at runtime. Every language exposes the same two configuration knobs: an explicit setToken(...) call, or the XCLIENT_TOKEN environment variable for CI / scripted use. Tokens are sent as Authorization: Bearer ... on every request and the library never logs them.

from ats_client import set_token
set_token("pat_…")
# or, equivalently:
# export XCLIENT_TOKEN=pat_…

Use the library

Save the downloaded file under your project as ats_client.py (or the equivalent for your language) and import the operation functions you need. Each function is named <model>_<op> (account_create, deal_list, lead_get, ...) and forwards to the matching HTTP endpoint with retry-on-429, exponential backoff, and Retry-After honoured automatically. List functions accept the standard query parameters (limit, offset, sort, q, plus the type's allowed filters); get/update/delete functions accept the row id as their first argument.

from ats_client import application_list, application_get, application_create, application_update, application_delete
# List the first 20 rows
page = application_list(limit=20, sort="-created_at")
print(page["data"], page["meta"]["has_more"])
# Create + read + update + delete
created = application_create({"name": "Example"})
fresh = application_get(created["id"])
application_update(created["id"], {"name": "Updated"})
application_delete(created["id"])

Available models

Each library exposes one function per operation per model. The list below is the one-to-one mirror of the HTTP endpoints this app exposes.

ModelFunctions
application
application_listapplication_getapplication_createapplication_updateapplication_delete
application_note
application_note_listapplication_note_getapplication_note_createapplication_note_updateapplication_note_delete
candidate
candidate_listcandidate_getcandidate_createcandidate_updatecandidate_delete
email_template
email_template_listemail_template_getemail_template_createemail_template_updateemail_template_delete
evaluation
evaluation_listevaluation_getevaluation_createevaluation_updateevaluation_delete
interview
interview_listinterview_getinterview_createinterview_updateinterview_delete
job
job_listjob_getjob_createjob_updatejob_delete
message
message_listmessage_getmessage_createmessage_updatemessage_delete
offer
offer_listoffer_getoffer_createoffer_updateoffer_delete
source
source_listsource_getsource_createsource_updatesource_delete
task
task_listtask_gettask_createtask_updatetask_delete

Environment variables

VariablePurpose
XCLIENT_TOKENPersonal access token used for every API call.
XCLIENT_BASE_URLOverride the baked-in server URL (testing only).

Analytics + updates

Each call sends one analytics event to the same dashboard as the web UI (operation name, library version, OS - no field values, no request bodies) so the team running this app can see how the integration is used. The data is processed securely; an audit log of every event tied to you can be requested at any time from the company operating the app. Separately, the library checks for a newer version once every 24 hours. In interpreted languages (Python, TypeScript on Node, JavaScript on Node, PHP, Ruby, Elixir) the on-disk file is replaced atomically and the next import picks up the new bytes. In compiled languages (Go, Java, Rust, C#, C++, Kotlin, Swift, Dart, Clojure) the source file is left as-is - users ship pre-compiled artefacts, so the version probe just stamps a timestamp you can surface at build-time. Set XCLIENT_NO_AUTOUPDATE=1 to disable the probe entirely.