End Point REST

Through authentication Basic

ℹ️ In the case of using Basic Authentication the validator end point to use is: https://api.sherlock.masiv.masivian.com/api/v1/Validator

Method: POST

ℹ️All requests must include a Header named Authorization, through which an HTTP authorization string of type Basic, for example, is specified:

For user user with password password, a Base64 text string must be generated from user:password, preceded by the term Basic and a blank space. Thus, the resulting authorization string would be: Basic dXNlcjpwYXNzd29yZA==.

Through Oauth 2.0 authentication (Optional on request during product configuration)

In the case of requiring authorization by OAuth 2.0, sherlock has the OAuth 2.0 authorization protocol which issues access tokens that client applications can use to access protected resources on behalf of the resource owner.

The path for its consumption is https://auth-sherlock.masivapp.com in which a POST request will be made.

OAuth 2.0 request requirements

  1. It must include a Header called Authorization, through which an HTTP authorization string of type Basic is specified, in this case a Base64 text string must be generated from user:password, preceded by the term Basic and a blank space. Thus, the resulting authorization string would be: Basic dXNlcjpwYXNNzd29yZA==
  2. It must include a Header called Content-Type, through which the media type of the resource is specified. The Content-Type for this request must be application/x-wwww-form-urlencoded.
  3. In the Body of the request, grant_type and scope must be added. Where grant_type indicates the type of user credentials and this must be equal to client_credentials and scope which indicates the scope of user permissions and must be equal to resource/configuration which will be provided at the time of configuration.

Oauth 2.0 Request Response

The response to the request is given as follows:

{
		"access_token": "<ACCESS_TOKEN_RESPONSE>",
		"expires_in": 3600,
		"token_type": "Bearer"
}

ℹ️ In the case of using OAuth 2.0 Authentication the validator end point to use is: https://oauth-sherlock.masivapp.com/api/v1/validator