Ping

Use /ping to obtain the public key of the RSA public/private key pair for the Platform API. This key encrypts data being sent to the LaunchKey Platform via the API, and to verify any RSA signature received from the LaunchKey Platform.

Request

Method:GET
Path:/v1/ping
Accept Types:application/json

Body

None

Query String Parameters

fingerprint:Optional - Send the fingerprint of the most recently known public key. If it matches the current public key fingerprint, only api_time will be returned in the response.

Example

GET /v1/ping?fingerprint=654844f2320ae99a57b4f76b8cbcdfbe HTTP/1.1
Accept-Type: application/json
Content-Length: 0

Response

Status:200 OK
Content Type:application/json

Body

A JSON string will be returned in the response body with the following attributes:

fingerprint:Public Key Fingerprint - Fingerprint of returned key. This key can be used in the request to reduce the response size when the fingerprint of the key in the request matches the current public key.
api_time:ISO 8601 Date/Time - When the response was generated by from Platform API
key:string - Public key of the RSA public/private key pair for the Platform API. Returned only if fingerprint isn't provided in the request or doesn't match the fingerprint of the current key.

Note

Additional attributes may be passed in the JSON object but these attributes are deprecated and will be removed in the next major release of the API.

Example For Fingerprint Match

HTTP/1.1 200 OK
Server: nginx
Date: Sun, 10 Nov 2013 03:56:21 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 56
Connection: keep-alive
Strict-Transport-Security: max-age=31536000; includeSubdomains

{
    "api_time" : "2015-04-23T05:25:24Z"
}

Example For No Fingerprint Match

HTTP/1.1 200 OK
Server: nginx
Date: Sun, 10 Nov 2013 03:56:21 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 600
Connection: keep-alive
Strict-Transport-Security: max-age=31536000; includeSubdomains

{
    "fingerprint" : "654844f2320ae99a57b4f76b8cbcdfbe",
    "api_time" : "2015-04-23T05:25:24Z",
    "key" : "-----BEGIN PUBLIC KEY-----\n\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8zQos4iDSjmUVrFUAg5G\nuhU6GehNKb8MCXFadRWiyLGjtbGZAk8fusQU0Uj9E3o0mne0SYESACkhyK+3M1Er\nbHlwYJHN0PZHtpaPWqsRmNzui8PvPmhm9QduF4KBFsWu1sBw0ibBYsLrua67F/wK\nPaagZRnUgrbRUhQuYt+53kQNH9nLkwG2aMVPxhxcLJYPzQCat6VjhHOX0bgiNt1i\nHRHU2phxBcquOW2HpGSWcpzlYgFEhPPQFAxoDUBYZI3lfRj49gBhGQi32qQ1YiWp\naFxOB8GA0Ny5SfI67u6w9Nz9Z9cBhcZBfJKdq5uRWjZWslHjBN3emTAKBpAUPNET\nnwIDAQAB\n\n-----END PUBLIC KEY-----\n"
}

User Contributed

LaunchKey links to user contributed code as a resource to its community. LaunchKey does not in any way guarantee or warrant the quality and security of these code bases. User contributed code is supported by the creators. If you do find a link from the site to user contributed code that is malicious or inappropriate in any way, please report that link to LaunchKey immediately and we will investigate the claim. Submit any issue to LaunchKey support at https://launchkey.com./support. ×