Skip to content

Okatana PHP SDK

Okatana PHP SDK for the Okatana External API v1. Designed for server-to-server integrations, scheduled jobs, CI/CD automation, operational tooling, and application backends.

Explicit Okatana host required

The client requires an explicit API deployment URL. https://okatana.newfoundcodes.com is the documentation site, not a default API host.

SDK features

Provides six service objects: organizations, projects, boards, tickets, documents, and notifications. Features include schema-based request validation, immutable/fluent request objects, PSR-18 HTTP transport, normalized bearer authentication, JSON response decoding, Laravel paginator helpers, typed models, and status-specific exceptions.

Service methods map directly to routes, return ApiResponse, and preserve unknown response fields.

Typical client lifecycle

use Newfoundcodes\Okatana\OkatanaClient;

$client = OkatanaClient::create(
    baseUrl: $_ENV['OKATANA_URL'],
    apiKey: $_ENV['OKATANA_TOKEN'],
);

$projects = $client->projects()->list($_ENV['OKATANA_ORG'])->collection();

baseUrl normalizes to /api/v1. Origin and full API base are both valid:

https://okatana.internal.example      -> https://okatana.internal.example/api/v1
https://okatana.internal.example/api/v1 -> unchanged

Design principles

  1. Explicit deployment configuration. Requires deployment URL before sending tokens.
  2. One method per endpoint.
  3. Predictable transport. Uses PSR-18 semantics; accepts custom PSR-18 implementations.
  4. Conservative writes. Limits automatic retries to safe reads.
  5. Schema-aware. Validates documented constraints; preserves unknown fields in responses.
  6. Raw requests. OkatanaClient::request() supports unmapped v1 routes.

Documentation

See Installation, Configuration, and Quickstart. For production integration behavior, read Errors, Retries and rate limits, and Security.