Skip to content

Latest commit

 

History

History
242 lines (172 loc) · 4.31 KB

documentation.md

File metadata and controls

242 lines (172 loc) · 4.31 KB

The Turing Game: API Reference

Conversations

Start Conversation

Start a conversation with another user or the AI.

Endpoint:

GET /api/conversation/start

Parameters:
Name Type Description
auth string The user's authentication token.
Response:
{
	"cid": 123
}
Example:
curl -X GET SERVER_URL/api/conversation/start -u abcdef_12345

{
	"cid": 123
}

End Conversation

Submit your guess and finish the conversation. Supply the conversation ID in the URL.

Endpoint

POST /api/conversation/end/:cid

Parameters:
Name Type Description
auth string The user's authentication token.
guess integer The user's guess (i.e. 0 for human or 1 for bot).
Response:

None.

Example:
curl -X POST SERVER_URL/api/conversation/flag/123 -u abcdef_12345 -d '"guess":1'

Flag Conversation

Flag the other user in a conversation for inappropriate behaviour. Supply the conversation ID in the URL.

Endpoint

GET /api/conversation/flag/:cid

Parameters:
Name Type Description
auth string The user's authentication token.
Response:

None.

Example:
curl -X GET SERVER_URL/api/conversation/flag/123 -u abcdef_12345

Send Message

Send a message in a conversation. Supply the conversation ID in the URL.

Endpoint

POST /api/conversation/send/:cid

Parameters:
Name Type Description
auth string The user's authentication token.
text string The message content.
Response:

None.

Example:
curl -X POST SERVER_URL/api/conversation/send/123 -u abcdef_12345 -d '"text":"Hello World!"'

Receive Message

Get all of the messages from the other user in a conversation. Supply the conversation ID in the URL.

Endpoint

GET /api/conversation/receive/:cid

Parameters:
Name Type Description
auth string The user's authentication token.
Response:
{
	"cid": 123,
    "messages": [
    	{
        	"id": 0,
            "text": "Hello World!",
            "timestamp": "2020-01-01 00:00:00"
        },
        { }
    ]
}
Example:
curl -X GET SERVER_URL/api/conversation/receive/123 -u abcdef_12345'

{
	"cid": 123,
    "messages": [
    	{
        	"id": 0,
            "text": "Hello World!",
            "timestamp": "2020-01-01 00:00:00"
        },
        {
        	"id": 1,
            "text": "How are you?",
            "timestamp": "2020-01-01 00:00:10"
        }
    ]
}

Leaderboards

Get Leaderboards

Get an object containing the highest scoring users.

Endpoint

GET /api/leaderboards

Parameters:

None.

Response:
{
	"users": [
    	{
        	"rank": 0,
            "username": "user1",
            "score": 0.95
        },
        { }
    ]
}
Example:
curl -X GET SERVER_URL/api/leaderboards

{
	"users": [
    	{
        	"rank": 0,
            "username": "user1",
            "score": 0.95
        },
        {
        	"rank": 1,
            "username": "user2",
            "score": 0.80
        },
        {
        	"rank": 2,
            "username": "user3",
            "score": 0.79
        },
        {
        	"rank": 3,
            "username": "user4",
            "score": 0.52
        },
        {
        	"rank": 4,
            "username": "user5",
            "score": 0.00
        }
    ]
}

Authentication

Introduction

Firebase provides a built-in method to authenticate users using Google Sign-In. It requires a SHA1 fingerprint which should be present in the Firebase console and generates a UserID for a logged in user. The UserID is persistent which means that it will be unique for a specific user and will be the same on each log in. This ID will be used to associate data with a specific user.

API

When a user is logged in on the front-end they should be assigned a session token. This token will be used by the back-end to verify the user and proceed with data transfer. The API's authentication should be set up as outlined in this document.