Get a brand by url

Get a brand based on the client domain or host domain.

get

Get the brand information by the client domain or host domain.

We will check the client domain first that is the domain of the client that is requesting the resource.

If the client domain is not found, we will check the host domain.

If the host domain is not found, return 404 error.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

404

The brand was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/brands/by-url

HTTPcURLJavaScriptPython

GET /api/v1/brands/by-url HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "parentId": "sApKpllz4sAplsmzha",
    "code": "EXA",
    "name": "Example",
    "abbr": "EXA",
    "description": "JFW",
    "tags": "Example, JFW",
    "status": "Inactive",
    "isDefault": false,
    "isSystem": false,
    "profile": {
      "slogan": "Example Slogan",
      "logoURL": "https://www.example.com/logo.png",
      "faviconURL": "https://www.example.com/favicon.ico",
      "primaryColor": "#000000",
      "primaryColorHover": "#000000",
      "secondaryColor": "#000000",
      "tertiaryColor": "#000000"
    },
    "setting": {
      "domainWhiteListURLs": "https://whitelist.example.io",
      "googleAnalyticsAccount": "UA-******-1",
      "reCaptchaKey": "6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy",
      "currencyCode": "EXA",
      "cdnURL": "https://cdn.example.com",
      "cdnFolder": "exam_cdn",
      "passwordPolicyLevel": "Low"
    },
    "domains": []
  },
  "errors": []
}