Platforms
Getting all platforms
This API gives you list of all the platforms supported by TexAu.
get
Authorizations
Query parameters
startnumberRequiredExample:
Page
1
limitnumber · max: 50RequiredExample:
Size
50
qstringOptionalExample:
Search Param
string
typestringOptionalExample:
Search Type
string
Header parameters
X-TexAu-ContextstringRequired
Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’
Responses
200
Platforms fetch successful
application/json
401
Unauthorized access
403
Your plan does not have API access
422
Requested workspace does not belongs to you
500
Error in fetching platforms
get
GET /api/v1/public/platforms?start=1&limit=50 HTTP/1.1
Host:
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*
{
"success": true,
"message": "Platforms fetch successful",
"total": 1,
"data": [
{
"id": "Platform ID",
"name": "Platforms Name",
"label": "Platforms Label",
"auth": {
"type": "cookie|apiKey|OAuth2",
"isOptional": false
}
}
]
}
Get platform by ID
This API gives you the list of authVariables
that will be used in adding a social account.
get
Authorizations
Path parameters
platformIdstringRequiredExample:
The platform id
62176e85121058d00e8cd67c
Header parameters
X-TexAu-ContextstringRequired
Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’
Responses
200
Platform fetched successfully
application/json
401
Unauthorized access
403
Your plan does not have API access
404
Platform Auth Variables does not exist or selected platform is invalid
422
Requested workspace does not belongs to you
500
Error while fetching Platform Auth Variables
get
GET /api/v1/public/platforms/{platformId} HTTP/1.1
Host:
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*
{
"success": true,
"message": "Platform fetched successfully",
"data": {
"id": "Platform ID",
"name": "Platforms Name",
"label": "Platforms Label",
"auth": {
"type": "cookie|apiKey|OAuth2",
"isOptional": false
},
"authVariables": [
{
"id": "The ID of platform authentication variable",
"placement": "header|query|body|url|cookie",
"type": "text",
"description": "text",
"label": "CSRF Token",
"name": "csrf-token"
}
]
}
}
Last updated