Base URL: //api.tecxipio.com/rvs/v0
Version: 0.11
Schemes: https
For authentication an additional header must be sent with each request. HMAC Authentication is used.
Endpoints with symbol need authentication.
Endpoints with symbol are premium features.
The HTTP header: Authorization: HMAC <AUTH_ID>:<TIMESTAMP>:<DIGEST>
GET+/collections/{cid}/videos/+1508237283
Example JavaScript code to calculate the HMAC signature:
var authId = 'yourAuthId';
var secret = 'yoursecret';
var timestamp = Math.floor(Date.now()/1000);
var requestMethod = 'GET';
var requestPath = '/collections/123456/videos/';
var payload = requestMethod + '+' + requestPath + '+' + timestamp;
var hash = CryptoJS.HmacSHA256(payload, secret);
var hashInHex = CryptoJS.enc.Hex.stringify(hash);
Check your request limits in the TECXIPIO App.
There are general rate limits you can check with response headers X-Tec-Rate-Limit-*
Video registration and searches have parallel access limits, which would be quit with status code 423
URL path segments
cid: ID of collection.
vid: ID of video in the search index.
Path | Operation | Description |
---|---|---|
POST |
Add collection. |
|
GET |
Get list of collections. |
|
PUT |
Update collection based on ID. |
|
DELETE |
Delete collection based on ID. |
|
POST |
Add source video to search index. |
|
GET |
Get list of video IDs available in search index. |
|
PATCH |
Add additional fingerprint to video in search index. |
|
DELETE |
Delete video based on ID from search index. |
|
GET |
Get status to video processing. |
|
PUT |
Add additional video details and description by ID. |
|
GET |
Get saved video details by ID. |
|
POST |
Enqueue direct search by video content or fingerprint. |
|
GET |
Get list of adhoc searches available in search index. |
|
GET |
Get result for enqueued search by ID. |
|
GET |
Get status to enqueued search. |
|
POST | ||
GET | ||
DELETE | ||
POST |