Access

To access the Harvest Media API you will need to acquire a Service Token.

Once a service token has been issued, the user will have access to the API.

Get Service Token

The Service Token authenticates the AccessKey and issues access to the webservice.

Request:

GET /getservicetoken/{accessKey}

Returns access details which include:

• Token value

• Expiry of the Token

Example:

http://[service_URL]/getservicetoken/edab64768aff0a618a736b2e0a564dced9215ae719fb854218cbd8d2cc07b30079ca822f8d8d1

Successful Response:

<responseservicetoken>

 

<token value=”62b6b849463ad1ac” expiry=”2011-08-18T15:08:46.273″ utcoffset=”10″ />

</responseservicetoken>

Error Response:

<responseservicetoken>

 

<error>

<code>1</code>

<description>Corrupt Input Data</description>

</error>

</responseservicetoken>

 

Get Service Token Info

This operation will return the details of the service token, notably the expiry date and the creation date. Date format will be UTC+10 or UTC+11 and shown as YYYY-MM-DDTHH:MM:SS:SSS.

Request:

GET /getservicetokeninfo/{serviceToken}

Returns Service Token details  details which include:

• Token value

• Expiry of the Token

• UTC Offset

Example:

http://[service_URL]/getservicetokeninfo/87bc0276fdaf0d2e8b0c245bf5c47e68

Successful Response:

<responseservicetoken><token value=”62b6b849463ad1ac” expiry=”2011-08-18T15:08:46.273″ /></responseservicetoken>

Error Response:

<responseservicetoken><error><code>5</code><description>Invalid Token</description></error></responseservicetoken>


Expire Token

This operation will expire the provided Service Token immediately.

Any subsequent calls to the API using the provided Service Token will result in an error response.

Request:

POST /expiretoken/{serviceToken}

Parameter Type Status
ServiceToken String Mandatory
Request Body XML Mandatory

Example:

http://[service_URL]/getservicetokeninfo/87bc0276fdaf0d2e8b0c245bf5c47e68

Successful Response:

<responsecode><code>OK</code></responsecode>

Error Response:

<responseservicetoken><error><code>5</code><description>Invalid Token</description></error></responseservicetoken>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.