Inkress DevelopersSDKs
SDKs
Official SDKs for the stacks you use, or call the REST API from anything that speaks HTTPS.
| Package | Version | What it's for |
|---|---|---|
@inkress/admin-sdk | 1.2.0 | Orders, payment links, subscriptions, merchants, payouts and webhooks. TypeScript, for Node, browsers and React Native. |
@inkress/storefront-sdk | 1.1.2 (GitHub) | Products, carts and checkout for storefronts, in the browser or Node. Install from GitHub: npm install github:inkress/storefront-sdk; npm's latest is an older 0.0.1. |
@inkress/app-bridge | 0.1.0 (GitHub) | Embedded apps: merchant identity, Inkress's own UI and session tokens. Not on npm yet: npm install github:jamlance/app-bridge. |
@inkress/app-kit | 0.1.0 (GitHub) | Embedded apps on React Router 7: session, OAuth, an authenticated SDK in loaders, webhooks. Not on npm yet: npm install github:jamlance/app-kit. |
inkress (Elixir) | 0.1.0 (GitHub) | Orders and webhook verification for Phoenix and the BEAM. Not on Hex yet: add it from GitHub. |
Node
Install with npm install @inkress/admin-sdk. Pass your key as accessToken and mode: "sandbox" for test keys or "live" for live ones. Set mode yourself: without it the SDK sends requests to the live API. Errors throw an InkressApiError with status and result.
Elixir
Add {:inkress, github: "inkress/inkress-elixir"} to your deps (it isn't on Hex yet). Inkress.new(api_token: …, merchant_username: …, mode: :sandbox) makes a client; Inkress.Orders.create/2 creates orders and Inkress.Webhooks verifies deliveries. Calls return {:ok, _} or {:error, _}. For other endpoints, call the REST API.
Anything else
The REST API is JSON over HTTPS with bearer tokens. Every guide shows cURL, Node, PHP and Elixir.