API Configuration
Welcome to the API configuration guide for the Observ platform.
This document provides detailed instructions on how to effectively set up and manage API interactions within the Observ environment. Understanding how to configure and use APIs is crucial for seamless integration and automation of processes on the Observ platform.
Obtain the API Endpoint
Endpoint URL Construction: Start with the Observ website address and append
/apiserver
to access the API service.Example: If your Observ URL is
https://www.linkervisionai.com/observ
, your API endpoint will behttps://www.linkervisionai.com/observ/apiserver
Authentication
To ensure secure access to our API, authentication is required for each call.
Below are the details for setting up the necessary headers for HTTP API calls and parameters for Websocket connections.
Headers
Authorization
Bearer {bearer token}
Do authentication
Yes
X-Service-Id
Get from Observ UI
Which workspace you want to access
Yes
1. Get Auth Token
This API endpoint is used to obtain an access token for authentication purposes. Please note the following important considerations:
Token Expiry: The obtained token expires after 24 hours.
Rate Limit: The usage of this API is limited; frequent calls are discouraged to avoid hitting the rate limit.
Endpoint: POST /users/token
Body:
The user email you’re going to login VisionAI
string
Yes
password
The user password you’re going to login VisionAI
string
Yes
Example Request:
Response:
Response Fields:
access_token
The access token to for Bearer authorization
string
2. Get Service ID
Please open the Observ site with the workspace you want to access
Go to the system-management page, click the
API Configuration
button on the right-top cornerYou can see the Service ID on the pop-up window, please copy the
Service ID
Fill HTTP header name
X-Serivce-Id
with the copied ID
Last updated