Quick Start

Create an IBEXHub User

Register for an IBEXHub User at https://hub-dashboard.ibexmercado.com.

After confirming your email and setting your password, you will be taken to the dashboard. The dashboard let's you play around with all of IBEXHub's features, and tells you exactly what endpoints are called to make everything happen.

Guide to Making Requests

For almost all requests in IBEXHub you will need an AccessToken in the Authorization header. You can retrieve these by calling the Sign in route with your new password or using the RefreshToken (valid 7 days). (More details in the Auth API reference).

You also need to add the User Agent header depending on the type of HTTP client you're using to make requests. Check their docs here -> https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent

After SignIn, your next step should be Creating an Account. You need this accountID to create invoices, generate lightning addresses, and set up LNURLs.

POST {{url}}/auth/signup

SignUp with your temporary password and set your own.

Parameters

Responses

{
    "accessToken": "",
    "refreshToken": "",
    "accessTokenExpiresAt": 1647365307,
    "refreshTokenExpiresAt": 1647365307,
}

{
    "error" : "", // error message
}

Examples

const request = require('request');
 
const options = {
  method: "POST",
  url: 'https://ibexhub.ibexmercado.com/auth/signup',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    temporaryPassword: "yourtemppasswordfromsignupemail",
    email: "[email protected]",
    newPassword: "Examplepass1!" //min 8 characters, 1 capital, 1 number, 1 special
  })
};
 
function handleResponse(error, response, body) {
  if (!error && response.statusCode == 200) {
    const info = JSON.parse(body);
    console.log(info)
  }
}

request(options, handleResponse);

curl --request POST -H "Content-Type: application/json" \
'https://ibexhub.ibexmercado.com/auth/signup' \
--data-raw '{
    "email": "[email protected]",
    "temporaryPassword": "tempPassWord",
    "newPassword": "Bitcoin213#"
}'

For more information on how to create an API Reference go to Getting Started with Readme.com