Create a session with username and password

Request

Creates a session with a specified username and password.

Security
PublishableApiKey
Bodyapplication/json
usernamestringrequired

User's username.

passwordstringrequired

User's current password.

curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/storefront/login \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "password": "string"
  }'

Responses

Logged into account.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the session.

Example:"jwt_0YV7DEJX80CDRAKVTV478ZNJDR"
tokenstringread-only

Session token for authentication in the billing portal.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

expiredTimestring, (date-time)

Date and time when the session expired. The default value is one hour after the createdTime value.

Response
{ "id": "jwt_0YV7DEJX80CDRAKVTV478ZNJDR", "token": "string", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "expiredTime": "2019-08-24T14:15:22Z" }