API Quick Start

This documentation serves as your foundational guide to integrating Wallaby API's solutions seamlessly into your applications.

Getting started with the API

Start building with Wallaby API

This documentation serves as your foundational guide to integrating Wallaby API's solutions seamlessly into your applications. You can find essential insights into building with Wallaby API, an overview of Wallaby API's key concepts and features, quick start guides to speed up your development process, and information on how to securely authenticate your interactions with the API.

If your integrating a React (or any other JS front-end library) application, we recommend using our Typescript SDK for a faster implementation.

If your application does not support browser APIs You will need to customize your storage solution based on your application's requirements and stack.

Setup the API client

In order to interact with the API directly, you will need to setup the API client. Here's an example of how to do it in TypeScript:

1. Choose an HTTP client: You can use any HTTP client like fetch (built into modern browsers), axios, request, etc. The choice depends on your preference and the specific needs of your project.

2. Authentication with the API: You will need an API key to interact with any endpoint. // Check here for more info on getting your API key.

3. Authenticate your users to get the JWT, which is just a jwt token generated after the user authenticates with your system, and preferably passes some sort of a 2fa method.

4. The wallby access token is another jwt generated by wallaby after authenticating, check this next section to learn how to use the api to authenticate with wallaby.

This documentation will use axios for its examples.

const baseUrl = 'https://dev-testnet.wallaby.cash';

const headers = {
  'X-Api-Key': WALLABY_API_KEY,
  'X-Client-JWT': JWT, // Look up how to generate the JWT section.
  'Content-Type': 'application/json',
  Authorization: `Bearer ${WALLABY_ACCESS_TOKEN}`, // the wallaby access token received back after authenticating. More on that in the next example.
}

const httpClient = axios.create({
  baseURL: this.baseUrl,
  headers: headers,
});

// Now you can use that http client to call Wallaby's endpoints
const response = await httpClient.get('/users/${userId}/assets')