POST api/Access
Generates a Token Id to enable access to other API modules. Send a POST request with your Access Id and Private Key in the form body.
Request Information
URI Parameters
None.
Body Parameters
Json string containing Access Id and Private Key
AccessPayloadName | Description | Type | Additional information |
---|---|---|---|
accessId |
Pre-assigned Access ID |
string |
None. |
privateKey |
Pre-assigned Access Code or Private Key |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "accessId": "7d689f2d-e7de-5c7d-bb2d-aa785e21d055", "privateKey": "test12345678" }
text/plain, text/xml, application/xml, application/x-www-form-urlencoded
Sample:
Not applicable.
Response Information
Resource Description
Returns a json string containing the generated Token Id and the requesting IP address.
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
{ "tokenId": "E046JDLD4709DSKDSLK093LKF09LDFK30932498RFJKSFDUWEUIWE98", "ipAddress": "192.168.0.1" }
text/plain, text/xml, application/xml
Sample:
Not applicable.