REST API for Asset Management (TIPWeb-IT) provides programmatic access to instructional materials and asset data, allowing districts to integrate with other systems and perform large-scale operations such as retrieving, updating, or managing records. This functionality is intended for users with experience in software development, web services, and the Asset Management interface.
What Is a REST API?
An API (Application Programming Interface) defines how systems communicate with each other. A REST API follows REST (Representational State Transfer) principles and uses HTTP requests to interact with data.
REST APIs support standard operations known as CRUD:
- Create – Add new records
- Read – Retrieve existing data
- Update – Modify existing records
- Delete – Remove records
API and Asset Management
The Asset Management REST API allows districts to access and manage data directly within the live production environment. This enables integration with external systems and supports bulk data operations.
- API actions are performed in real time and update the live database immediately.
- Changes made through the API are permanent and cannot be undone.
- The API is optimized for processing large datasets efficiently.
You can access the full Asset Management API Documentation.
Common API Use Cases
View Assets Issued to Students or Staff
The API can retrieve detailed asset information, including:
- Tag Number
- Serial Number
- Site Name
- Student or Staff Name
- Asset Status
- Product Name and Type
- Manufacturer and Model
- Suggested Price
- Due Date and Date Issued
- Accessories (name, description, price)
Update Asset Status for Room-Based Items
The API allows updating the status of assets assigned to rooms (not individuals). Available status values include:
- Auctioned
- Available
- Disposed
- In Repair
- In Use
- Lost
- Recycled
- Returned To Vendor
- Sold
- Stolen
- Surplus
- Used For Parts
Set Up API Authentication
- Navigation:
- Admin View
- Integration Settings
- API and SSO Information
To use the API, you must retrieve authentication credentials from Asset Management.
- Log in to Asset Management with Admin credentials.
- Navigate to Management > District Settings.
- Open the “API and SSO Information” section.
- Record your API URL, Secret Key, and Passphrase.
Authentication requires generating a JWT bearer token:
- Send credentials to the API login endpoint using an HTTP POST request.
- A bearer token is returned and must be included in subsequent API requests.
- Tokens remain valid for eight hours, after which a new token is required.
Sample API Request: Get Version
You can test API connectivity using a simple request to retrieve the API version. Replace {{TIPWebAPI_Url}} with your district’s API URL.
curl --location -g '{{TIPWebAPI_Url}}/api/Home' \--header 'Content-Type: application/json'
This request returns a JSON response that includes the API version number. This endpoint does not require authentication.
If the API is not enabled for your district, contact Frontline Customer Support.