Skip to content
Wasp AssetWasp AssetWasp Asset Help

Try the API with Postman

You don’t need to write code to try the public API. This walkthrough uses Postman, a free tool for sending web requests, to search your assets. The same steps work in any similar tool, and they show you exactly what your own integration needs to send.

Before you begin

Section titled “Before you begin”
  • Postman installed (the desktop app or the web version).
  • An API access token. See API access tokens.
  • Your Wasp Asset address, the one you sign in at, such as https://yourcompany.waspassetcloud.com/.
  • The function you want to call. This example uses the asset search, public-api/assets/assetinfosearch. Look up others in the API function reference.

Send a request

Section titled “Send a request”
  1. In Postman, click New and choose HTTP to open a new request. If you want to keep it, click Save and give it a name (for example, assetinfosearch) and a collection.
  2. Set the method to POST.
  3. In the address box, enter your Wasp Asset address followed by the function path: 
    https://yourcompany.waspassetcloud.com/public-api/assets/assetinfosearch
  4. Open the Headers tab and add:
    • Key Authorization, Value Bearer followed by a space and your token.
    • Key User-Agent, with any value that identifies your integration (Postman adds one for you automatically, so make sure it’s still ticked).
  5. Open the Body tab, choose raw, and pick JSON from the format list. Postman adds the Content-Type: application/json header for you.
  6. Enter the request body. This one finds active assets whose tag or description contains “HP”: 
    {
      "SearchPattern": "HP"
    }
  7. Click Send.

The response appears below the request. A status of 200 OK means the call worked. The Data list in the response holds the matching assets, and HasError is false.

If it doesn’t work

Section titled “If it doesn’t work”
What you see What to check
400 Bad Request or no response The token is wrong, expired, or replaced by a newer one, or the Bearer prefix is missing. Generate a new token if needed.
403 Forbidden The User-Agent header is missing, or the body contains HTML, script, or other markup that our firewall blocks.
415 Unsupported Media Type The body isn’t set to raw → JSON.
422 Unprocessable Entity The JSON is valid but a value in it isn’t acceptable. Read Messages in the response.
429 Too Many Requests Wait the number of seconds shown in the Wasp-OverloadProtection-Reset response header, then send again.
500 Internal Server Error Check that the body is valid JSON with the field names the function expects.

See API result codes for more detail on each one.

Section titled “Related”