Skip to main content

Access Key - Summary

When accessing /AccessKey via GET, the Slingshot API Server will return an XML document that contains the summary data of the Access Key contained in the request headers. This data can be used to determine the cause of any 'Invalid Access Key' messages from the server.

HTTP Method and URL​

GET https://api.ravenslingshot.com/accesskey

URL Parameters​

None.

HTTP Query Parameters​

None.

HTTP Headers​

To learn more about these parameters, read about Authentication.

HeaderDescription
X-SS-AccessKey[Required] Token issued to a Slingshot user from the Raven Slingshot Portal Server.
X-SS-APIKey[Required] Token issued to the Slingshot developer from Raven.
X-SS-Signature[Required] The signature generated for a specific request.
X-SS-TimeStamp[Required] The timestamp of when the request was generated.

Sample Responses​

XML​

<accesskeydetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.ravenslingshot.com/AccessKeyDetail/2010">
<accesskey>B3A3B66E-413E-4018-8782-D297F4950F12</accesskey>
<id>10</id>
<friendlyname>John's access key</friendlyname>
<description>Key given to John to manage my data</description>
<isactive>true</isactive>
<contact>RavenCustomer@gmail.com</contact>
<expirationdatetime>2010-11-17T06:00:00Z</expirationdatetime>
</accesskeydetail>

JSON​

{
"AccessKey": "B3A3B66E-413E-4018-8782-D297F4950F12",
"ID": "10",
"FriendlyName": "John's access key",
"Description": "Key given to John to manage my data",
"IsActive": true,
"Contact": "RavenCustomer@gmail.com",
"ExpirationDateTime": "2010-11-17T06:00:00Z"
}