Creating a Session for a Single Use
Endpoint Access URL: https://rest.everyware.com/api/Default/CreateSession [POST]
The CreateSession API can be used to enable single sign on into Everyware. Session links expire automatically after 24 hours. It is recommended a new session link be created each time a user opens Everyware from your system.
Inbound Parameters
Parameter | Description | Required |
---|---|---|
Menu_Item | Ex: Available Structures: payment, invoice, messages, subscription, campaign | REQUIRED |
Date_Time | Time stamp of the session request. | OPTIONAL |
Unique_ID | ExternalID for user, if provided on internal parameters. | OPTIONAL |
External_API_Keys | Collection of strings. Keys for the sites/locations the userID named above should be able to access. | REQUIRED |
{
"menu_Item": "Invoice",
"date_Time": "123456789",
"unique_ID": "123",
"external_api_keys": [
"fvge8b51-jn1d-4cd3-12nh-ca167g6hu667"
]
}
{
"session_ID": "ea9e8b51-081d-4cd3-957d-ca16796af667",
"embedded_URL": "https://portal.everyware.com/account/loginmenu?sess=ea9e8b51-081d-4cd3-957d-ca16796af667"
}
Using Postman (www.postman.co), create an http POST request to https://restapi.everyware.com/api/Default/CreateSession. Enter your payload in the body and click “Send.”
The API will return the session ID and the embedded URL for your iFrame.
Updated 13 days ago