REST API Postman -kokoelmat (Spot)

Viimeksi päivitetty: 1.4.2025

Postman on suosittu API-testausympäristö, joka mahdollistaa REST API -päätepisteiden toteuttamisen ja testaamisen.

Postman tarjoaa HTTP-verkon yhteyden muodostamiseksi REST API:iin, mahdollistaa HTTP-otsikoiden ja GET/POST-datan mukauttamisen sekä sallii mukautetun koodin suorittamisen JavaScript-variantin avulla.

Ennalta määritellyt toteutukset voidaan tuoda Postmaniin kokoelmien kautta (pohjimmiltaan JSON-tiedosto, joka sisältää kunkin API-päätepisteen konfiguraation ja koodin).

Seuraavassa on esimerkkejä Postman-kokoelmista spot REST API:llemme:

Huomaa, että yllä olevat kokoelmat on tarkoitettu API:n käytön demonstroimiseksi, joten ne eivät toteuta kaikkia mahdollisia syöteparametreja. Kokoelmiin voidaan lisätä päätepisteitä ja parametreja tarkastelemalla asianmukaista API-dokumentaatiota ja käyttämällä annettuja päätepisteitä/parametreja esimerkkeinä.

Nopeana viitteenä seuraavassa on esimerkki Postman-kokoelman JSON-sisällöstä:

bash

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": {}
}

Tarvitsetko lisää apua?