Skip to main content
Skip writing requests by hand: import the full Partner API into Postman in one step. It’s generated directly from the same OpenAPI spec that powers the API Reference, so it’s always in sync with what’s documented here.

Download the collection

spenza-partner-api.postman_collection.txt — save it, then rename the extension to .json before importing (see below for why).

​
Import it

1

Get the file into Postman

Either:
  • Import via link (recommended — no rename needed): in Postman, Import → Link, and paste:
    Postman fetches and parses the collection regardless of the URL’s file extension.
  • Import via file: use the Download the collection button above, rename the downloaded file’s extension from .txt to .json, then Import → File in Postman. (The .txt extension is a limitation of how this docs site serves static files — the content itself is a standard Postman Collection v2.1 JSON document either way.)
2

Set your credentials

Open the collection’s Variables tab (or use the companion environment below) and fill in apiKey/apiSecret with your partner credentials.
3

Authenticate once

Run Authentication → Exchange credentials for a token. Its test script saves the returned token into the accessToken variable automatically — every other request inherits it via collection-level bearer auth.
4

Start calling endpoints

Every operation in the API Reference is here too, organized into the same folders (SIMs, Plans & Catalog, eSIM, Billing, Webhooks, and so on), with realistic example request bodies already filled in.

​
What’s pre-wired

  • Auth handled for you. Collection-level bearer auth reads from the accessToken variable, so you only authenticate once per session (tokens last 1 hour — re-run the auth request to refresh).
  • Idempotency by default. Every write request that accepts an Idempotency-Key header has it pre-filled with Postman’s dynamic {{$guid}} variable, so each send automatically uses a fresh key — retries are safe out of the box.
  • Correct no-auth exceptions. POST /api/v1.1/auth/token and GET /api/v3/transactions/{transactionId} are explicitly set to no-auth, matching their real behavior — no confusing 401s from a missing token where none is needed.
  • Port-in submission’s role requirement. POST /api/v3/port-in needs a token whose account role is Admin, Super Admin, or Standard Admin — a lower-privilege token gets a well-formed 403 FORBIDDEN, not a broken request.

​
Companion environment

Download the environment

spenza-partner-api.postman_environment.txt — same rename-before-import note as above. Pre-configures baseUrl, and empty apiKey/apiSecret/accessToken slots.

​
Next steps

  • Quickstart if you’d rather follow the same flow in curl/Node.js first.
  • Authentication for the full token-exchange contract this collection automates.
  • API Reference (sidebar) for the field-level schema behind every request in the collection.