REST API Integration

1. View device information.
2. Access event logs.
3. Add, delete, and edit labels.
4. Update severity settings for their device fleet.
5. Upgrade or downgrade the FWS Agent.
6. Modify notification settings.
   

Prerequisites

1. REST API credentials, including the Client ID and Client Secret, must be generated in the TSFA Cloud Portal.
2. A tool or platform (e.g., Postman, cURL) is required to request access tokens from the API.
3. Proper security measures, such as credential storage and token management, must be in place.
   

2. Request Access Token

Authenticate API Requests

To authenticate your API requests, use a tool like Postman or cURL to exchange your Client ID and Client Secret for an access token.

Example Using Postman:

1. Open Postman and create a new POST request.
2. Set the URL to the API's token endpoint: https://api.naea1.uds.lenovo.com/tsfa/external-api-service/(specify endpoints here)
   Refer to the list of endpoints here.
   You can download the list of endpoints from the cloud portal under Organization Settings > API Credentials.
3. In the Body, set it to x-www-form-urlencoded and include the following fields:
1. client_id: Your Client ID
2. client_secret: Your Client Secret
3. grant_type: Set to client_credentials
4. OrgId: Copy the OrgId from your organization's URL: https://portal-platform.naea1.uds.lenovo.com/uds001-orgname/
4. Click Send. The response will include the access token.
   

The access token will expire in 5 mins, so make sure the automated token refresh process is configured in your software.

 

3. Connect to the REST API in Your Platform

1. Open your platform’s API integration section and select the option to add a REST API or Web API.
2. Enter the API endpoint: e.g., https://api.naea1.uds.lenovo.com/tsfa/external-api-service/{specify-endpoint-here}
3. In the Header, include the access token:
1. Key: Authorization
2. Value: Bearer your_access_token
4. Add any required URL parameters, such as device identifiers or pagination settings.
5. Run the query. If successful, the system will retrieve the requested data.
   
   

1. Use the REST API to automate device management, patching, or configuration tasks across endpoints.
   
2. Example: Integrate Ansible to pull device health data via the API and generate reports.
   

1. Use REST API data to build visual dashboards or create custom reports.
2. Example: Connect Grafana to the API to visualize server uptime or hardware status metrics.
   

1. Integrate REST APIs to automate workflows between different systems.
2. Example: Use a REST API to send device alerts to a Slack channel or automate email notifications.