Authkey.create: Difference between revisions
Jump to navigation
Jump to search
w>Jguillo No edit summary |
m 13 revisions imported |
||
| (9 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
Creates a new authkey | Creates a new authkey. | ||
= Info = | = Info = | ||
| Line 5: | Line 5: | ||
* '''Signature:''' Requires signature using the sharedkey's private key | * '''Signature:''' Requires signature using the sharedkey's private key | ||
* '''Timestamp:''' Requires [[ztime parameter]] | * '''Timestamp:''' Requires [[ztime parameter]] | ||
* '''API trust level''': Standard | |||
= Parameters = | = Parameters = | ||
| Line 12: | Line 13: | ||
<nowiki>* Required parameter</nowiki> | <nowiki>* Required parameter</nowiki> | ||
= | = Returns = | ||
* '''authkeycreate''' | |||
** '''authkey''': New authkey | |||
** '''privatekey''': Private key associated to the new authkey | |||
'''IMPORTANT:''' You must save this private key for future use. It cannot be obtained again anywhere. If you lose an authkey's private key you will be forced to create a new authkey for the user. | |||
= Example = | |||
REQUEST: | REQUEST: | ||
| Line 23: | Line 31: | ||
RESPONSE: | RESPONSE: | ||
<pre> | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<authkeycreate> | |||
<authkey>23j22wtpoguzgzk0fag39sey6</authkey> | |||
<privatekey>1f5lcps1hvpo7y1sw175y5qkp</privatekey> | |||
</authkeycreate> | |||
</pre> | |||
[[Category:API component]] | |||
Latest revision as of 08:07, 7 May 2021
Creates a new authkey.
Info
- Component name: authkey.create
- Signature: Requires signature using the sharedkey's private key
- Timestamp: Requires ztime parameter
- API trust level: Standard
Parameters
- sharedkey*: Your application shared key
- ztime*: Z-Timestamp
* Required parameter
Returns
- authkeycreate
- authkey: New authkey
- privatekey: Private key associated to the new authkey
IMPORTANT: You must save this private key for future use. It cannot be obtained again anywhere. If you lose an authkey's private key you will be forced to create a new authkey for the user.
Example
REQUEST:
https://api.safecreative.org/v2/ ?component=authkey.create &sharedkey=zy9x4ol0ctg3btyswq7b5wi9 &ztime=1271749822099 &signature=4ed86580ab439b56251ed712e2554586b125f0ef
RESPONSE:
<?xml version="1.0" encoding="UTF-8"?> <authkeycreate> <authkey>23j22wtpoguzgzk0fag39sey6</authkey> <privatekey>1f5lcps1hvpo7y1sw175y5qkp</privatekey> </authkeycreate>