User.link

From SafeCreativeWiki

Jump to: navigation, search

Partner component to link a user to the application.

If the provided e-mail address corresponds to a Safe Creative user, an authorization will be automatically created for that user and a mail will be sent.

If no user was found with that e-mail address, a new user account will be created with the provided data and an authorization will be created. A mail will be sent to the user for him to activate the account.

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

Contents

Info

  • Component name: user.link
  • Signature: Requires signature using the shared key's private key
  • Timestamp: Requires ztime parameter
  • API trust level: Partner

Parameters

  • sharedkey*: Your application shared key
  • ztime*: Z-Timestamp
  • mail*: user mail
  • level*: desired authorization level: GET, ADD, MANAGE
  • 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 (default). 0 if user does not want notifications.
  • locale: user preferred locale

* Required parameter

(?): At least provide one field (First or last name)

Returns

  • userlink
    • usercode User code
    • authkey: Authorization key for this user
    • privatekey: Private key of the authorization

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"?>
<userlink>
  <usercode>0907300000160</usercode>
  <authkey>e5qxwqwuh2bowtp2u2w0v8vd</authkey>
  <privatekey>52c59d4dddn5n4ub3qs32osny</privatekey>
</userlink>
Personal tools
Safe Stamper API