Skip to main content

Inttegro TypeScript SDK

The Inttegro TypeScript SDK builds server-side integrations with typed requests, domain objects, exported API constants, and promise-based resource methods. It translates between idiomatic camelCase values and the API's JSON representation.

Start with MCP

Before writing SDK code, connect your MCP client and ask MCP to design the integration for your TypeScript application. Use the resulting implementation and test plan to guide the code you write with this SDK.

Install

The SDK requires Node.js 24 or newer. Install the package from npm:

npm install @inttegro/inttegro-sdk
Keep the SDK on the server

Load the secret API key securely from server-side code. Never place the key in browser JavaScript, a mobile bundle, or source control.

Create a client

import { InttegroClient } from '@inttegro/inttegro-sdk'

const inttegro = new InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})

Resource clients are available directly on inttegro, including orders, customers, products, prices, paymentMethods, purchaseIntents, refunds, balances, payouts, files, messages, apps, and keys.

See it in a complete app

Choose the experience closest to the one you want to build:

Each guide explains the buying journey, the server boundary, and the released source behind the live experience.

Observability

The global OpenTelemetry provider is used automatically. Pass a provider when the client should use an explicitly managed tracing pipeline:

const inttegro = new InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
  telemetry: { tracerProvider },
})

Inttegro emits vendor-neutral OpenTelemetry spans through the provider configured by your application. The SDK does not choose an exporter or observability vendor, and it does not send telemetry by itself.

Each public SDK call creates one CLIENT span named after the logical operation, such as inttegro.orders.create. HTTP attempts, retries, response receipt, decoding, and failures appear as events on that span. W3C trace context is propagated on outbound requests.

Span attributes and data-safety contract

The stable attributes are:

  • inttegro.operation.name, SDK language and SDK version
  • HTTP method and response status when available
  • destination host and the static API route template
  • the safe request identifier returned by the API
  • a low-cardinality failure category such as a timeout

SDK telemetry never records API keys, authorization headers, request or response bodies, customer or payment data, resource identifiers, dynamic URLs, query strings, exception messages, or stack traces.

To turn off Inttegro instrumentation for a client, use telemetry: { enabled: false }.

Report SDK failures​

Pass an application-owned callback to receive one typed report after an SDK operation finally fails:

import { InttegroClient, type ErrorReport } from '@inttegro/inttegro-sdk'

const enqueueError = (report: ErrorReport): void => {
  void report // Forward the report to your collector or queue.
}

const inttegro = new InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
  errorReporting: { reporter: enqueueError },
})

The default policy reports transport, timeout, decoding, SDK, unknown, and server-side failures. Expected API failures such as normal 4xx responses stay with the caller. Use policy: 'all' when the collector should receive those failures too. Cancellation is never reported.

Report fields and data-safety contract

A report contains:

  • the logical operation, static route, server host, status, duration, and safe request identifier when available
  • safe API error codes and a stable, low-cardinality fingerprint
  • SDK identity, exception type, and active trace identifiers

Reports never contain API keys, authorization headers, request or response bodies, customer or payment data, resource identifiers, dynamic URLs, query strings, exception messages, or stack traces.

Reporting is completely opt-in. Unless errorReporting.reporter is configured, the SDK does no reporting-specific timing or metadata preparation, creates no event ID or report object, and serializes nothing. Report construction and collector failures are isolated, so the caller still receives the original SDK failure.

Continue