Public API overview

The Wasp Asset public API lets your own software read and update your Wasp Asset data — assets, asset types, sites, locations, employees, customers, vendors, contracts, funding, attachments, transactions, and more — without anyone signing in to the web app. Use it to connect Wasp Asset to an ERP, an HR system, a help desk, or your own scripts.

Before you begin

• The public API requires the Complete edition. If no user in your account can see the API Access Token section on their profile, your edition doesn’t include it.
• You need an API access token. An administrator generates one for a user on that user’s profile. See API access tokens.
• You need your Wasp Asset address. API calls go to the same address you use to sign in, for example https://yourcompany.waspassetcloud.com/. On-premises customers use the address of their own Wasp Asset server.

How the API works

Every call follows the same pattern:

• Address — your Wasp Asset address followed by the function’s path. For example, the asset search function is public-api/assets/assetinfosearch, so the full address is https://yourcompany.waspassetcloud.com/public-api/assets/assetinfosearch.
• Method — most functions use POST. The function reference lists the method for each one.
• Authorization header — send Authorization: Bearer <your token>, with a single space between Bearer and the token.
• User-Agent header — every request must include a User-Agent header. Requests without one are blocked by the firewall with a 403 Forbidden response.
• JSON in, JSON out — the API accepts and returns JSON only. Set Content-Type: application/json on requests that send a body. Other formats (plain text, XML, HTML, form data) are rejected.

For example, this request body searches for active assets whose tag or description contains “HP”:

{
  "SearchPattern": "HP"
}

Every response wraps its data in the same envelope. Data holds the result, HasError tells you whether the call failed, and Messages explains what went wrong (or carries informational notes when it succeeded).

Tip

The quickest way to try a call is with a tool such as Postman. See Try the API with Postman for a step-by-step walkthrough.

Find the function you need

The API function reference lists every public API function, grouped by area, with its address, method, description, required permission, and the request and response fields:

Open the API function reference

You can also open it from your own Wasp Asset address by adding Help/API, for example https://yourcompany.waspassetcloud.com/Help/API. Click any function to see its full details and a sample request.

The functions are grouped into these areas:

Area	What it covers
Addresses and phones	Addresses and phone numbers for customers, employees, manufacturers, and vendors
Assets	Search, create, update, and export assets, and check an asset’s check-out status
Asset types	Asset type records
Attachments	Upload, list, and download files attached to records
Contracts	Contracts and the assets linked to them
Customers, employees, departments	People and organizations assets are assigned to
Funding	Funding sources and the assets linked to them
Sites and locations	Where assets are kept
Vendors and manufacturers	Who you buy from and who made the asset
Purchase orders	Create, search, update, and receive purchase orders
Transactions	Check out, check in, move, dispose, recover, and transaction history
Audits	Audit counts and reconciliation
System info	Confirm which product is hosted at an address

Note

Many save functions accept a batch of records in one call, up to a limit stated in the function reference (often 500). Send larger loads in several batches.

Permissions follow the user

A token acts as the user it was generated for. Every call is subject to that user’s role, so the API can do only what that person could do in the web app. For example, saving customer addresses requires the Edit Customer permission. For unrestricted access, generate the token for a dedicated user with Application Admin rights. See API access tokens.

Stay within the rate limit

If your integration sends too many requests too quickly, the API answers with 429 Too Many Requests. The response includes a Wasp-OverloadProtection-Reset header (and a standard Retry-After header) giving the number of seconds to wait. Wait at least that long before you send the next request. A request sent before the time is up is refused again with a new wait time.

When you page through large result sets, pass the total count from your first page back on later pages (the function reference describes how for each paging function). Doing so skips a costly recount on every page and helps you stay under the limit.

See API result codes for every status code the API returns.

Code samples and client libraries

• C# (.NET) — install the AssetCloudPublicAPI package from NuGet to get a typed client for every function. For a complete working project, download the C# and TypeScript samples, open Wasp.MobileAsset.PublicApi.sln, and build it. NuGet restores the packages it needs. Put your token and your Wasp Asset address in App.config before you run it.
• TypeScript and JavaScript — the same download includes a TypeScript client and sample in the TypeScript folder.
• Offline reference — the API help file (CHM) is a downloadable copy of the function reference for Windows.

Caution

Windows blocks help files downloaded from the internet, so the CHM opens with blank pages. Right-click the file in your Downloads folder, choose Properties, tick Unblock, click Apply, then OK, and open it again.

Related

• API access tokens — generate the token your integration signs in with
• Try the API with Postman — make your first call without writing code
• API result codes — what each HTTP status means and how to fix it
• Zapier integration — automate Wasp Asset events without writing code
• Callouts — have Wasp Asset call your system when something happens