Postman Guide
Video Guide
Overview
Postman is an application designed to help with API integration and exploration. Intuitive for different tech skill levels, Postman is the tool of choice both for experienced developers and no-code enthusiasts to become familiar with our available endpoints, requests, and responses.
Using our Postman Collection, you can start testing our API before writing a single line of code.
Prerequisites
Create an API user with our Quickstart Guide or Sandbox Quickstart Guide, or watch the video above to see how to create an API user on a Sandbox environment.
Installation
- Install Postmanor use Postman offline.
- Download the NCW Collection & Boilerplate from the official Fireblocks Github ncw-docs repo.
- Go to Collections, and then press Import and select the downloaded
ncw-postman-collection.json
file. - Go to Environments, and then press Import and select the downloaded
Boilerplate Fireblocks Environment.postman_environment.json
file.
Configuration
- In the top-right corner, select No Environment > Boilerplate Fireblocks Environment.
- Select the Environments tab and then configure the following parameters:
- fireblocksApiKey: This parameter is the API key you can copy from the Fireblocks Console after creating an API user.
- fireblocksSecretKey: This is the
fireblocks_secret.key
file you created in the Quickstart Guide or downloaded in the Sandbox Quickstart Guide. - baseUrl: For production workspaces, use
https://api.fireblocks.io/v1
. For sandbox workspaces, usehttps://sandbox-api.fireblocks.io/v1
.
Your result should be similar to the following:
Making your first request
Important
The
invokeWalletRpc
endpoint should only be triggered by an action originating from an end-user device. Testing it from Postman or your backend will only provide partial results. Validate this endpoint once you complete setup.
-
First, call the Create a new wallet endpoint.
-
Select Send and then wait for the response. You should receive the following
201 Created
response:
Good job! You have created your first non-custodial wallet with Fireblocks!
Updated 6 months ago