User.findbymail: Difference between revisions
Jump to navigation
Jump to search
w>Mpolo m Added InvalidProtocol notice |
m 3 revisions imported |
||
| (One intermediate revision by one other user not shown) | |||
| Line 8: | Line 8: | ||
* '''Signature''': Requires signature using the shared key's private key | * '''Signature''': Requires signature using the shared key's private key | ||
* '''Timestamp''': Requires ztime parameter | * '''Timestamp''': Requires ztime parameter | ||
* '''Protocol''': Requires HTTPS (or InvalidProtocol error result (See [[Error handling]])) | |||
* '''API trust level''': Partner | * '''API trust level''': Partner | ||
= Parameters = | = Parameters = | ||
Latest revision as of 08:07, 7 May 2021
Partner component to find if the provided e-mail address corresponds to a Safe Creative user.
You must be a Safe Creative partner to use this component.
Info
- Component name: user.findbymail
- Signature: Requires signature using the shared key's private key
- Timestamp: Requires ztime parameter
- Protocol: Requires HTTPS (or InvalidProtocol error result (See Error handling))
- API trust level: Partner
Parameters
- sharedkey*: Your application shared key
- ztime*: Z-Timestamp
- mail*: user mail
* Required parameter
Returns
- user-found true if found, false otherwise
Example
REQUEST:
https://api.safecreative.org/v2/ ?component=user.findbymail &mail=sholmes%40baker.fake &sharedkey=zy9x4ol0ctg3btyswq7b5wi9 &ztime=1271749826106 &signature=3b2d5552b5cd969c370ce70dae280a76dc844895
RESPONSE:
<?xml version="1.0" encoding="UTF-8"?> <user-found>false</user-found>