Description
ip1SignOn.process accepts IP1 internal user ID or user email address and registers the user ID/email address against an API session ID (unique ID that is passed in JSON node “id”). Once this signon API is processed, same session ID needs to be passed in subsequent APIs so that the subsequent APIs can use the signon user ID automatically.
The sign on user ID will be used for user access check, user restricted search or other user related process in the following APIs if it provides same API session ID.
- ip1Customer.process
- ip1Customers.get
- ip1Customers.DlvAdr.process
- ip1CustomerDlvAdrs.get
- ip1CustomerClass.process
- ip1Items.get
- ip1CustomerOrderList.get
- ip1FieldValues.get
- ip1FieldAttributes.get.
Input/Output parameters
| Input | Type | Description |
| userId | 10A | User ID |
| emailAddress | 120A | Email address |
| Output | Type | Description |
| status | 1A | blank = OK, E=error |
JSON example
View JSON request and response exampleExample 1: Sign on by user ID
{
“IptorAPI”: “1.0”,
“method”: “ip1SignOn.process”,
“params”: {
“userId”: “AUMARMCK”
},
“id”: “1234567890”
}
Example 2: Sign on by email address
{
“IptorAPI”: “1.0”,
“method”: “ip1SignOn.process”,
“params”: {
“emailAddress”: “[email protected]”
},
“id”: “1234567890”
}
Response:
{
“IptorAPI”: “1.0”,
“data”: {
“status”: “”
},
“id”: “1234567890”
}
Response format
For standard response format for IP1 API methods, see Response format.
