Use the Inttegro API in Insomnia

Import native Insomnia requests for every public Inttegro API operation. The collections include request examples, shared variables, response checks, and a safe hosted-checkout workflow.

Get the Insomnia collectionRead the API quickstart

Import and configure

1. Create or open one Insomnia project.
2. Import 00-environment.insomnia.yaml and the API-area collections you need into that project.
3. Under the imported Inttegro API global environment, create and select a private sub-environment before entering real values.
4. Set api_key in that private environment. Keep the published value empty.
5. Give idempotency_key a new stable value for each new logical operation. Reuse it only when retrying the same request with the same body.

Successful create requests save returned IDs to the active environment. For example, a customer created in the Customers collection becomes available to Payment Methods and Checkout without copying its ID by hand.

What is available

Area	What you can test
Checkout and orders	Hosted checkout and the complete order lifecycle
Customers and payment methods	Customer records and reusable payment methods
Catalog and Purchase intents	Products, prices, Purchase intents, and Buy links
Money movement	Financial accounts, balances, balance transactions, and payouts
Communications	Notifications, schedules, broadcasts, templates, and one-time passwords
Files	Files, file links, and third-party upload requests
Platform	Apps, API keys, and reference data
Refunds	Refund creation, lookup, and history

Start with hosted checkout

Import workflows/checkout-quickstart.insomnia.yaml and run Create hosted checkout followed by Look up created order. It creates a finalized order, captures order_id and checkout_url, and looks the order up. It does not request or confirm payment.

To run the same workflow in CI, pass protected environment variables to Inso at runtime:

inso -w insomnia/workflows/checkout-quickstart.insomnia.yaml \
  run collection "Inttegro API — Checkout Quickstart" \
  --env-var "api_key=${INTTEGRO_API_KEY}" \
  --env-var "base_url=${INTTEGRO_API_BASE_URL}" \
  --env-var "order_number=${INTTEGRO_ORDER_NUMBER}" \
  --env-var "idempotency_key=${INTTEGRO_IDEMPOTENCY_KEY}" \
  --bail

Choose a new order number and idempotency key together for each new checkout. Keep both unchanged when retrying that checkout after a timeout. Avoid shell tracing or plaintext result output while passing credentials this way.

Run only the operation you intend

Some collections can send messages, schedule payouts, change settings, cancel resources, or delete files. Do not run every collection indiscriminately against a live account.

Versions

The collection bundle version matches the public API contract version. Insomnia schema 5.1 is the file format, not the Inttegro API version. Read collection_version from the shared environment and pin the bundle's Git commit for repeatable CI.