Postman
Download
| File | URL |
|---|---|
| Collection | /aletaplanet.postman_collection.json |
| Environment | /aletaplanet.postman_environment.json |
Import both files into Postman. Then select the environment from the picker in the top right.
Requests will fail with missing_credentials until the environment is active
because every request uses Authorization: Bearer {{access_token}}.
Set up the environment
The environment includes five variables. You only need to set the first two before you can start making requests.
| Variable | Set it to |
|---|---|
base_url | https://api.aletaplanet.com, which works for both environments |
access_token | A token from POST /oauth/token. It's stored as a Postman secret and expires after 15 minutes |
cardholder_id | Filled in as you go from the response to Create a cardholder |
account_id | Filled in as you go from the response to Create an account |
card_id | Filled in as you go from the response to Issue a card |
The token request isn't included in the collection on purpose. It requires a JWT signed with your private key, which Postman can't generate.
Run the token step from the
quickstart using
Python or Node, then paste the resulting token into access_token. Once it
expires after 15 minutes, repeat the process.
The token determines both your organization and environment, so base_url stays
the same for sandbox and production. See
environments.
The token doesn't determine which program you're working with. Create an
account includes program_id in its request body and is the only request in
the collection that requires it. Replace the placeholder with one of your own
program IDs before running it.
To find your program IDs, use List your programs in the Programs folder, or check Settings → Programs in Cockpit.
Idempotency keys are generated automatically for each request using Postman's
{{$guid}}. This means sending a mutation again creates a new operation instead
of retrying the previous one.
That's a good default when exploring the API, but it's not what you want when testing retry behavior. For retry tests, replace the generated value with a fixed key. See idempotency.
What's in the collection
The collection includes every operation currently served by the API, organized by resource:
- Programs
- Cardholders
- Accounts
- Cards
- Transactions
Request bodies come with working example values, including valid document types, amounts in minor units, and accepted enum values.
IDs are placeholders that follow the same format as real IDs, for example
chd_01HX8ZQ2K4M7P9RSTVWXYZAB. Replace them with IDs from your own responses.
List requests include their available query parameters, but they're disabled by default. The first request therefore returns an unfiltered page. Enable the parameters you need before sending it.