Client Library for Partner API

Overview

The Apploi Partner API Client Libraries provide type-safe, high-level access to core Partner API endpoints. They wrap the generated SDKs with native language types, validation, pagination helpers, and structured error handling so integrations are production-ready from day one.

  • SDKs available:
    • Python SDK: Native dataclasses, input validation, and clear exceptions
    • TypeScript SDK: Strong typings, enums, and ergonomic configuration
  • Ideal for teams integrating with Apploi to read or sync applicants, jobs, and related entities, with built-in patterns for pagination and retries.

Quick links

  • Python SDK → Docs
  • TypeScript SDK → Docs
  • Partner API Reference -> Docs

Requirements and environments

  • API access and an Apploi-issued API key
  • Environments:
    • Production by default
    • Staging and testing supported via configurable base URL

Authentication

  • Provide your API key in client configuration
  • Optional additional authorization header supported where required
  • Base URL configurable for non-production environments

Key capabilities

  • Consistent client initialization and authentication flows
  • Native language types and input validation
  • Pagination and rate-limit–friendly patterns
  • Structured errors for authentication, validation, and API failures
  • Versioned releases designed for CI/CD workflows

When to choose each SDK

  • Python: Ideal for Python-first stacks, dataclasses, type hints, and pytest-based testing
  • TypeScript: Ideal for Node.js services with full IDE typing's and enums

Support and versioning

  • Semantic versioning with release notes
  • Tested against current Partner API versions
  • Guidance for upgrading across minor and major versions