@TODO: 1. the collection is not updated 2. maybe better to focus only on the admin APIs

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

1. Install Postmanor use Postman offline.
2. Download the NCW Collection & Boilerplate from the official Fireblocks Github ncw-docs repo.
3. Go to Collections, and then press Import and select the downloaded ncw-postman-collection.json file.
4. Go to Environments, and then press Import and select the downloaded Boilerplate Fireblocks Environment.postman_environment.json file.

Configuration

1. In the top-right corner, select No Environment > Boilerplate Fireblocks Environment.
2. Select the Environments tab and then configure the following parameters:
   1. fireblocksApiKey: This parameter is the API key you can copy from the Fireblocks Console after creating an API user.
   2. fireblocksSecretKey: This is the fireblocks_secret.key file you created in the Quickstart Guide or downloaded in the Sandbox Quickstart Guide.
   3. baseUrl: For production workspaces, use https://api.fireblocks.io/v1. For sandbox workspaces, use https://sandbox-api.fireblocks.io/v1.

Your result should be similar to the following:

Understanding Our REST APIs

🚧

Important

The API keys are intended solely for use by authorized administrators within your organization who manage the integration and hold the corresponding private keys.

Our Embedded Wallet (EW) solution offers two distinct types of REST API endpoints, each designed for specific roles and purposes as defined in our API Roles documentation.

1. EW Signer Endpoints:

   • Primary Usage: These endpoints are typically invoked from your customer application via the EW SDK. This integration empowers your end-users to securely access and manage their own wallets.
   • Alternative Usage (EW Signer User API): For testing, administrative, or other specific needs, these Signer endpoints can also be called directly using the EW Signer User API. This method allows a designated administrator within your organization, who possesses the necessary private keys for the EW Signer, to interact with any wallet in the workspace.

2. EW Admin Endpoints:

   • Purpose: These endpoints are dedicated to administrative operations that manage your workspace and overall configuration.
   • Access: Access to EW Admin endpoints is restricted and requires the EW Admin User API. These calls can only be made directly by an authorized administrator within your organization who holds the private keys for EW Admin functionalities.

🚧

Important

These administrator-level API keys should never be embedded in client-side code or directly within your end-user application. End-users interact with their wallets via the EW SDK, which handles authentication via the configured Oauth setup.

Making your first request

Create a Wallet

📘

Note

While end-users will have wallets created for them seamlessly via the EW SDK integrated into your application, administrators also have the capability to create wallets directly.

We'll demonstrate this direct administrative method for testing purposes.

1. First, call the Create a new wallet endpoint.

   

2. 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!