Postman ialah persekitaran ujian API yang popular yang membolehkan pelaksanaan dan pengujian titik akhir REST API.
Postman menyediakan rangkaian HTTP untuk menyambung ke REST API, membenarkan pengepala HTTP dan data GET/POST disesuaikan, dan membenarkan kod tersuai dilaksanakan menggunakan varian JavaScript.
Pelaksanaan yang telah ditetapkan boleh diimport ke dalam Postman melalui koleksi (pada asasnya fail JSON yang mengandungi konfigurasi dan kod untuk setiap titik akhir API).
Berikut ialah contoh koleksi Postman untuk spot REST API kami:
Ambil perhatian bahawa koleksi di atas bertujuan sebagai demonstrasi penggunaan API, oleh itu ia tidak melaksanakan setiap parameter input yang mungkin. Titik akhir dan parameter tambahan boleh ditambahkan pada koleksi dengan menyemak dokumentasi API yang sesuai dan menggunakan titik akhir/parameter yang disediakan sebagai contoh.
Untuk rujukan pantas, berikut ialah contoh kandungan JSON dalam koleksi 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": {}
}