...
Request
HTTP Verb : GET
URL : http://{WS_URL}/api/{returnType}/{domainCode}/customer
Parameters | Location | Type | Required | Default | Accepted |
|---|---|---|---|---|---|
token | Header | String(26) | v |
...
Code | Success | Message |
|---|---|---|
0 | v | get user info |
1 | domaincode malformed | |
2 | connexion error | |
3 | token is empty | |
4 | no token with that key | |
5 | invalid token | |
10 | user not connected | |
99 | uncatched exception |
...
Create customer
| Warning |
|---|
A customer can't register a new account if he's already connected via the login webservice. |
When created, an email is sent to the customers' e-mailaddress (see e-mail configuration). This e-mail contains a link the customer needs to visit in order to confirm his e-mailaddress. See the validation service for more information.
...
Request
HTTP Verb : POST
URL : http://{WS_URL}/api/{returnType}/{domainCode}/customer
| Note |
|---|
The password passed in the call has to be encrypted and salted. |
Parameters | Location | Type | Required | Default | Accepted |
|---|---|---|---|---|---|
login | Form | String | v | ||
password | Form | String | v | ||
Form | String | v | |||
title | Form | String | |||
firstname | Form | String | |||
lastname | Form | String | |||
prefix | Form | String | |||
birthdate | Form | Date | Format : yyyy-MM-dd | ||
company | Form | String | |||
language | Form | Integer | 1 | ||
newsletter | Form | Integer | 0 | ||
extra1 | Form | String | |||
extra2 | Form | String | |||
extra3 | Form | String | |||
favoriteShop | Form | Integer | |||
confirmationRequired | Form | Boolean |
| Tip |
|---|
With confirmationRequired set to false, the customer won't receive an email, and so won't have to confirm his email address before logging in. Then, he's automatically logged in. |
Response
Success
| Code Block |
|---|
{
"response": {
"success": true
"message": "user created"
"object": {
"customer": {
"id": 1043
"role": 1
"email": "spiderman@marvel.com"
"login": "spiderman"
"b2b": false
"newsletter": false
"waitingEmailValidation": true
}
}
}
} |
...
Request
HTTP Verb : PUT
URL : http://{WS_URL}/api/{returnType}/{domainCode}/customer
Parameters in path
Parameters | Location | Type | Required | Default | Accepted |
|---|---|---|---|---|---|
token | Header | String(26) | v | ||
Content-Type | Header | String | v | application/x-www-form-urlencoded | |
password | Form | String(40) | |||
Form | String | ||||
title | Form | String | |||
firstname | Form | String | |||
lastname | Form | String | |||
prefix | Form | String | |||
birthdate | Form | Date | |||
company | Form | String | |||
language | Form | Integer | |||
newsletter | Form | Boolean | |||
extra1 | Form | String | |||
extra2 | Form | String | |||
extra3 | Form | String | |||
favoriteShop | Form | Integer |
...
Request
HTTP Verb : GET
URL : http://{WS_URL}/{returnType}/{domainCode}/customer/resend
Parameters in path
Parameters | Location | Type | Required | Default | Accepted |
|---|---|---|---|---|---|
token | Header | String(26) | v | ||
Query | String |
...