Create a session
curl --request POST \
--url https://sandbox.api.btdx.io/sessions \
--header 'Content-Type: application/json' \
--data '
{
"appId": "ANAPPID",
"walletId": "OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET",
"apiKey": "password1234"
}
'import requests
url = "https://sandbox.api.btdx.io/sessions"
payload = {
"appId": "ANAPPID",
"walletId": "OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET",
"apiKey": "password1234"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
appId: 'ANAPPID',
walletId: 'OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET',
apiKey: 'password1234'
})
};
fetch('https://sandbox.api.btdx.io/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.btdx.io/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'appId' => 'ANAPPID',
'walletId' => 'OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET',
'apiKey' => 'password1234'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.btdx.io/sessions"
payload := strings.NewReader("{\n \"appId\": \"ANAPPID\",\n \"walletId\": \"OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET\",\n \"apiKey\": \"password1234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.api.btdx.io/sessions")
.header("Content-Type", "application/json")
.body("{\n \"appId\": \"ANAPPID\",\n \"walletId\": \"OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET\",\n \"apiKey\": \"password1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.btdx.io/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"appId\": \"ANAPPID\",\n \"walletId\": \"OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET\",\n \"apiKey\": \"password1234\"\n}"
response = http.request(request)
puts response.read_body{
"_meta": {
"_primary_document": "sessions",
"_count": 1
},
"sessions": [
{
"accessToken": "eyJ0eXAiOiJh....bBDA",
"refreshToken": "eyJ0eXAiOiJy....uHCQ",
"accessExpiresAt": "2099-01-01T23:59:59.999Z",
"refreshExpiresAt": "2099-01-01T23:59:59.999Z"
}
]
}{
"title": "Not found",
"details": [
"APIKey entity with ID of pa****34 not found for App with ID of ANAPPID"
]
}Session Management
Create a session
Create a session for the supplied credentials and receive access and refresh tokens. These tokens will be used for Bearer authentication, and passed as part of the authorization header where required.
NOTE: walletId should be omitted or set to null unless the API key being used is of type WALLET.
POST
/
sessions
Create a session
curl --request POST \
--url https://sandbox.api.btdx.io/sessions \
--header 'Content-Type: application/json' \
--data '
{
"appId": "ANAPPID",
"walletId": "OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET",
"apiKey": "password1234"
}
'import requests
url = "https://sandbox.api.btdx.io/sessions"
payload = {
"appId": "ANAPPID",
"walletId": "OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET",
"apiKey": "password1234"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
appId: 'ANAPPID',
walletId: 'OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET',
apiKey: 'password1234'
})
};
fetch('https://sandbox.api.btdx.io/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.btdx.io/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'appId' => 'ANAPPID',
'walletId' => 'OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET',
'apiKey' => 'password1234'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.btdx.io/sessions"
payload := strings.NewReader("{\n \"appId\": \"ANAPPID\",\n \"walletId\": \"OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET\",\n \"apiKey\": \"password1234\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.api.btdx.io/sessions")
.header("Content-Type", "application/json")
.body("{\n \"appId\": \"ANAPPID\",\n \"walletId\": \"OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET\",\n \"apiKey\": \"password1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.btdx.io/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"appId\": \"ANAPPID\",\n \"walletId\": \"OPTIONAL-ONLY-IF-APIKEY-IS-TYPE-WALLET\",\n \"apiKey\": \"password1234\"\n}"
response = http.request(request)
puts response.read_body{
"_meta": {
"_primary_document": "sessions",
"_count": 1
},
"sessions": [
{
"accessToken": "eyJ0eXAiOiJh....bBDA",
"refreshToken": "eyJ0eXAiOiJy....uHCQ",
"accessExpiresAt": "2099-01-01T23:59:59.999Z",
"refreshExpiresAt": "2099-01-01T23:59:59.999Z"
}
]
}{
"title": "Not found",
"details": [
"APIKey entity with ID of pa****34 not found for App with ID of ANAPPID"
]
}⌘I