High scores tables can use the following operations:

• Get table
• Check score elegibility
• Add a new record
• Delete the full table

This section introduces, in detail, the operations that can be used with our API:

This is made using the GET verb. For example:

GET https://highscores.ehehdada.com/api/{table_name}?table_key={table_key} HTTP/1.1

Notice just putting the link above into your browser won't give you anything, because the strings "{table_name}" and "{table_key}" are just there as an example.

Path parameters:

• 'table_name' is a URL encoded string for your high scores table. So, just putting the link above into your browser won't give you anything, because the string "table_name" is just there as an example.

Query parameters:

• 'table_key' can be used in substitution of the header parameter 'tablekey'

Request body:

• No body or empty string body is used for this request

The response is encoded in an array of high score records with the next JSON object structure:

For example:

GET https://highscores.ehehdada.com/api/test?table_key=test HTTP/1.1

[
  {"score":9999,"by_whom":"player#2","when_happened":2109020805,"ip4":3232235777,"ip6":null,"locale":"en-US"},
  {"score":123,"by_whom":"player#5","when_happened":2105951648,"ip4":3232235777,"ip6":null,"locale":"en-US"}
]

This request is also made using the GET verb. In some cases, an application may need to check if a score will be above a certain rank on the high score table (if, for example, you only want the player to enter their name if they are in the top ten). There is one situation where trouble might arise. Let's say we only want to get the player's name if the player is ranked 10th in the table or better. Alice and Bob both rank 10th at the same time, and both enter their names at the same time. However, the server will handle one of their GET requests first. In this case, no error will occur. But it is wise, to check if the user's entered name and score are present after they enter their name.

GET https://highscores.ehehdada.com/api/{table_name}/check?score={score}&by_whom={by_whom}&table_key={table_key} HTTP/1.1

Notice just putting the link above into your browser won't give you anything, because the strings "{table_name}", "{score}", "{by_whom}", and "{table_key}" are just there as an example.

Path parameters:

• 'table_name' is a URL encoded string of your high scores table

Query parameters:

• 'score' is the numeric value of the record to check.
• 'by_whom' is a string with the name of the player only mandatory if a player can only appear once in your high scores table.
• 'table_key' can be used in substitution of the header parameter 'tablekey'

Request body:

• No body or empty string body is used for this request

The response is encoded an JSON object with the Boolean value 'is_elegible':

For example:

GET https://highscores.ehehdada.com/api/test?score=123&table_key=test HTTP/1.1

{"is_elegible":true}

If your game or application can't send any request because the clock of player's device is not correctly set up, you can request to our server to return its timestamp. This request doesn't need authentication.

GET https://highscores.ehehdada.com/timestamp HTTP/1.1

Path parameters:

• None

Query parameters:

• None

Request body:

• No body or empty string body is used for this request

The response is encoded an JSON object with the numeric value 'timestamp':

For example:

GET https://highscores.ehehdada.com/timestamp HTTP/1.1

{"timestamp":1406652098}

To insert a record into your high score table, you will need to use the POST verb. The server will accept the request if the given record effectively can be inserted in somewhere inside of the table, and it will return the position inside of the table as a numeric value. If the record was not successfully inserted, this request it will return a null value for the score's position.

POST https://highscores.ehehdada.com/api/{table_name} HTTP/1.1

Notice just putting the link above into your browser won't give you anything, because the string "{table_name}" is just there as an example.

Path parameters:

• 'table_name' is a URL encoded string of your high scores table.

The request body is the record to insert encoded in JSON format:

The response is the field 'position' encoded inside of an JSON object:

For example:

POST https://highscores.ehehdada.com/api/test HTTP/1.1
timestamp: 1406652640397
tablekey: test
fingerprint: 9652d046366ff644aa30df7bf8b5143b73d2524445746d37ff03602ad79257d9
X-Requested-With: XMLHttpRequest
Content-Length: 83

{"score":"123","by_whom":"player#5","when_happened":1406652640694,"locale":"en-US"}

{"position":0}

Please be advised that this feature is deprecated and it will be removed from the API. It will be available in the future admin panel.

To delete your high score table and start over, you will need to use the DELETE verb.

DELETE https://highscores.ehehdada.com/api/{table_name} HTTP/1.1

Notice just putting the link above into your browser won't give you anything, because the string "{table_name}" is just there as an example.

As alternative for systems that do not support DELETE (for example, Unity), we have added the next alternative using GET verb instead:

GET https://highscores.ehehdada.com/api/{table_name}/deleted/ HTTP/1.1

This still requires the fingerprint field and the other headers listed in this API documentation.

Path parameters:

• 'table_name' is a URL encoded string of your high scores table.

Request body:

• No body or empty string body is used for this request

This request doesn't return any body in the response.

For example:

DELETE https://highscores.ehehdada.com/api/test HTTP/1.1
timestamp: 1406652827374
tablekey: test
fingerprint: 41ebe0de2ba4c26551d91448abdf470a0ed19944cac9efd652baf3ef2b24960f
X-Requested-With: XMLHttpRequest

GET https://highscores.ehehdada.com/api/test/deleted/ HTTP/1.1
timestamp: 1419700348862
tablekey: test
fingerprint: 54988e72fa15175767f28036dd00e3c0aca9808137af7faa294b99a3f938bc8b
X-Requested-With: XMLHttpRequest