Platforms

Getting all platforms

This API gives you list of all the platforms supported by TexAu.

get

Authorizations

Query parameters

startnumberRequired

Page

Example: 1

limitnumber · max: 50Required

Size

Example: 50

qstringOptional

Search Param

Example: string

typestringOptional

Search Type

Example: string

Header parameters

X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

get

HTTPcURLJavaScriptPython

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

Header parameters

X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

get

HTTPcURLJavaScriptPython

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"
      }
    ]
  }
}