Platforms

Getting all platforms

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

GET/api/v1/public/platforms

Authorization

bearer

Query parameters

Header parameters

Response

200204401422500

Platforms fetch successful

Body

application/json

success*boolean

message*string

Example: "Platforms fetch successful"

total*number

data*array of PlatformData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/platforms?start=0&limit=0', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false,
  "message": "Platforms fetch successful",
  "total": 0,
  "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/api/v1/public/platforms/{platformId}

Authorization

bearer

Path parameters

platformId*string

Header parameters

Response

200204401404422500

Platform fetched successfully

Body

application/json

success*boolean

message*string

Example: "Platform fetched successfully"

data*PlatformByIdData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/platforms/{platformId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false,
  "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"
      }
    ]
  }
}