Sign in method
POST {{baseUrl}}/Global/v1/signin
Performs the login in OAS API, validating the informed credentials and returns the access token to the API resources.
Schema Definitions
Request
Attribute | Data type | Description |
---|---|---|
customerAuthentication | String | Provide customer login information here. |
passwordAuthentication | String | Provide customer password here. |
Response
Attribute | Data type | Description |
---|---|---|
success | Boolean | Boolean indicating if the operation was sucessfull. |
message | String | Operation custom message. |
data | String | Token bearer to use as authentication for other requests to the OAS API. |
Request Body
{"customerAuthentication"=>"{{$randomUserName}}", "passwordAuthentication"=>"{{$randomPassword}}"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | The Content-Type header field is used to specify the nature of the data in the body of an entity. OAS REST APIs support application/json. | |
Accept | string | The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand. OAS REST APIs support text/plain. |
RESPONSES
status: OK
{"success":true,"message":"Authenticated","data":"eyJhbGciJIUzI1NiIsInR5cCI6IkpXVCJ9......mMjNjYWYiLCJlHAiOjE2Dk3MDk0NzcsImlzcyIk9BUyZCI6Ik9BUyJ9......tiVWRXtdiMrGgmMmN1h0WH4rb95APsv4"}