Work.certificate: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
(Created page with 'Sends a work registration certificate to the user mail address. = Info = * '''Component name:''' work.certificate * '''Signature:''' Requires signature using the authkey's priva…')
 
m (5 revisions imported)
 
(4 intermediate revisions by 2 users not shown)
Line 6: Line 6:
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Authorization level:''' GET
* '''Authorization level:''' GET
* '''API trust level''': Standard


= Parameters =  
= Parameters =  
* '''authkey*:''' User's authorization key
* '''authkey*:''' User's authorization key
* '''ztime*:''' Z-Timestamp
* '''ztime*:''' Z-Timestamp
* '''code:''' Work code
* '''code*:''' Work code
* '''locale:''' Locale for mail message. If not specified, user default locale will be used.


<nowiki>* Required parameter</nowiki>
<nowiki>* Required parameter</nowiki>
Line 18: Line 20:
** '''state''': ready
** '''state''': ready


= Sample =
= Example =
REQUEST:
REQUEST:



Latest revision as of 08:07, 7 May 2021

Sends a work registration certificate to the user mail address.

Info

  • Component name: work.certificate
  • Signature: Requires signature using the authkey's private key
  • Timestamp: Requires ztime parameter
  • Authorization level: GET
  • API trust level: Standard

Parameters

  • authkey*: User's authorization key
  • ztime*: Z-Timestamp
  • code*: Work code
  • locale: Locale for mail message. If not specified, user default locale will be used.

* Required parameter

Returns

  • restvalueresponse
    • state: ready

Example

REQUEST:

https://api.safecreative.org/v2/
?component=work.certificate
&authkey=Bb7NTK14QGeHjluE3vziqQ
&code=1003030120266
&ztime=1273061092076
&signature=0c941f02e79c1265b4799bebb1b184c4875da070

RESPONSE:

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