User.modify: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
No edit summary
m (7 revisions imported)
 
(4 intermediate revisions by one other user not shown)
Line 17: Line 17:
* '''mail:''' user mail
* '''mail:''' user mail
* '''firstName:''' first name of the user
* '''firstName:''' first name of the user
* '''middleName:''' middle name of the user
* '''lastName:''' last name of the user
* '''lastName:''' last name of the user
* '''addressLine1:''' user address line 1
* '''addressLine1:''' user address line 1
Line 31: Line 30:
= Returns =
= Returns =


* '''userlink'''
* '''restvalueresponse'''
** '''usercode''' User code
** '''state''': ready
** '''authkey''': Authorization key for this user
** '''privatekey''': Private key of the authorization


= Sample =
= Example =


REQUEST:
REQUEST:
Line 59: Line 56:
<pre>
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<userlink>
<restvalueresponse>
   <usercode>0907300000160</usercode>
   <state>ready</state>
  <authkey>e5qxwqwuh2bowtp2u2w0v8vd</authkey>
</restvalueresponse>
  <privatekey>52c59d4dddn5n4ub3qs32osny</privatekey>
</userlink>
</pre>
</pre>


[[Category:API component]]
[[Category:API component]]

Latest revision as of 08:07, 7 May 2021

Partner component to modify a user account. User account must have been created with user.link.

You must be a Safe Creative partner to use this component.

Info

  • Component name: user.modify
  • Signature: Requires signature using the authorization key's private key
  • Timestamp: Requires ztime parameter
  • Authorization level: MANAGE
  • API trust level: Partner

Parameters

  • authkey*: Authorization key
  • ztime*: Z-Timestamp
  • mail: user mail
  • firstName: first name of the user
  • lastName: last name of the user
  • addressLine1: user address line 1
  • addressLine2: user address line 2
  • addressZip: user address zip code
  • addressCity: user address zip city
  • addressCountry: user address country code (see user.countries)
  • sendNotifications: 1 if user wants to be sent daily notifications of his operations. 0 if user does not want notifications.
  • locale: user preferred locale

* Required parameter

Returns

  • restvalueresponse
    • state: ready

Example

REQUEST:

https://api.safecreative.org/v2/
?component=user.link
&sharedkey=zy9x4ol0ctg3btyswq7b5wi9
&level=MANAGE
&mail=sholmes%40baker.fake
&firstname=Sherlock
&lastname=Holmes
&addressline1=221B+Baker+Street
&addressline2=City+of+Westminster
&addresscity=London
&addresscountry=GB
&locale=en
&ztime=1271749826106
&signature=3b2d5552b5cd969c370ce70dae280a76dc844895

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<restvalueresponse>
  <state>ready</state>
</restvalueresponse>