Run Brand Check

Developing

POST

https://brandcheck-nonprod-api-dev.azurewebsites.net/api/v1/px/runbrandcheck

This endpoint use to run "brandcheck" from PX

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "projectId": "string",
    "path":"https://some.url.of.asset.png",
    "Callback" : {
	  "Endpoint" : "px.com/api/getbrandchecresult", //post request
	  "Token" : "eyvyvtuyxccvugvygvygcvxcuvbcxvbxcvhvbv"
  }
        
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://brandcheck-nonprod-api-dev.azurewebsites.net/api/v1/px/runbrandcheck' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "projectId": "string",
    "path":"https://some.url.of.asset.png",
    "Callback" : {
	  "Endpoint" : "px.com/api/getbrandchecresult", //post request
	  "Token" : "eyvyvtuyxccvugvygvygcvxcuvbcxvbxcvhvbv"
  }
        
}'

Responses

🟢200Success

application/json

Body

Example

{
    "data": {
        "brandCheckResultId": "7f3695f7-22bb-4204-8449-059530597238",
        "status": "InProgress"
    },
    "statusCode": 200,
    "isSucceded": true,
    "errors": []
}

🟠400Validation Failed Response

🟠404Record Not Found

🔴500Server Error

Modified at 2024-05-22 05:55:53

Create Project

Brand Check Result