Postman est un environnement de test d'API populaire qui permet d'implémenter et de tester des points de terminaison d'API REST.
Postman fournit la mise en réseau HTTP pour se connecter à l'API REST, permet de personnaliser les en-têtes HTTP et les données GET/POST, et permet d'exécuter du code personnalisé à l'aide d'une variante JavaScript.
Les implémentations prédéfinies peuvent être importées dans Postman via des collections (essentiellement un fichier JSON contenant la configuration et le code pour chaque point de terminaison d'API).
Voici des exemples de collections Postman pour notre API REST Spot :
Veuillez noter que les collections ci-dessus sont destinées à être une démonstration de l'utilisation de l'API, elles n'implémentent donc pas tous les paramètres d'entrée possibles. Des points de terminaison et des paramètres supplémentaires peuvent être ajoutés aux collections en consultant la documentation de l'API appropriée et en utilisant les points de terminaison/paramètres fournis comme exemples.
Pour une référence rapide, voici un exemple du contenu JSON d'une collection 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": {}
}