Postman è un popolare ambiente di test API che consente di implementare e testare gli endpoint API REST.
Postman fornisce il networking HTTP per connettersi all'API REST, consente di personalizzare le intestazioni HTTP e i dati GET/POST e permette l'esecuzione di codice personalizzato utilizzando una variante JavaScript.
Le implementazioni predefinite possono essere importate in Postman tramite collezioni (essenzialmente un file JSON contenente la configurazione e il codice per ogni endpoint API).
Di seguito sono riportate alcune collezioni Postman di esempio per la nostra API REST spot:
Si noti che le collezioni di cui sopra sono intese come dimostrazione dell'utilizzo dell'API, pertanto non implementano ogni possibile parametro di input. Endpoint e parametri aggiuntivi possono essere aggiunti alle collezioni consultando l'appropriata documentazione API e utilizzando gli endpoint/parametri forniti come esempi.
Per una rapida consultazione, di seguito è riportato un esempio del contenuto JSON all'interno di una collezione Postman:
Bash
{
"info": {
"_postman_id": "b530d6e8-8aa3-403d-b8ab-1665d4606eab",
"name": "Kraken REST API - GetWebSocketsToken Endpoint",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "GetWebSocketsToken",
"event": [
{
"listen": "prerequest",
"script": {
"id": "e11ed019-722d-4ecf-8ddf-1f724e5b1ab4",
"exec": [
"api_key = \"API PUBLIC KEY\"",
"api_secret = CryptoJS.enc.Base64.parse(\"API PRIVATE KEY\");",
"api_nonce = (Date.now() * 1000).toString();",
"api_endpoint = \"/0/private/GetWebSocketsToken\";",
"api_post = \"nonce=\" + api_nonce;",
"",
"api_sha256 = CryptoJS.SHA256(api_nonce + api_post);",
"api_sign = CryptoJS.algo.HMAC.create(CryptoJS.algo.SHA512, api_secret);",
"api_sign.update(api_endpoint, api_secret);",
"api_sign.update(api_sha256, api_secret);",
"api_sign = api_sign.finalize().toString(CryptoJS.enc.Base64);",
"",
"pm.globals.set(\"api_nonce\", api_nonce);",
"pm.globals.set(\"api_key\", api_key);",
"pm.globals.set(\"api_signature\", api_sign);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "API-Key",
"type": "text",
"value": "{{api_key}}"
},
{
"key": "API-Sign",
"type": "text",
"value": "{{api_signature}}"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "nonce",
"value": "{{api_nonce}}",
"type": "text"
}
]
},
"url": {
"raw": "https://api.kraken.com/0/private/GetWebSocketsToken",
"protocol": "https",
"host": [
"api",
"kraken",
"com"
],
"path": [
"0",
"private",
"GetWebSocketsToken"
]
}
},
"response": []
}
],
"protocolProfileBehavior": {}
}