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

AttributeData typeDescription
customerAuthenticationStringProvide customer login information here.
passwordAuthenticationStringProvide customer password here.

Response

AttributeData typeDescription
successBooleanBoolean indicating if the operation was sucessfull.
messageStringOperation custom message.
dataStringToken bearer to use as authentication for other requests to the OAS API.

Request Body

{"customerAuthentication"=>"{{$randomUserName}}", "passwordAuthentication"=>"{{$randomPassword}}"}

HEADERS

KeyDatatypeRequiredDescription
Content-TypestringThe 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.
AcceptstringThe 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"}