Welcome to SocialPoint's API Documentation! You can use this API to access our API endpoints: APG Players and Trivia Players. This will enable you to offer seamless registration, automatic login, and gameplay when using our platform alongside your own software.

The API is organized around REST and it accepts and returns JSON content. It uses standard HTTP response codes, HTTP request methods are listed in this article.

Here's a list of the parameters covered in this article:


Authentication

  • The API uses API keys to authenticate requests

  • Authentication is performed using HTTP Basic Auth

  • API key must be provided in the header of the request

  • All requests must be made over SSL/TLS

  • Each event has a unique API key

  • API keys can be modified and revoked


API Keys

API Keys are unique to each event, and they can be found under your event's settings. Click here for instructions on how to find your API Key.


Rate Limiting

  • API Keys have a maximum rate limit of 720 per hour.

  • Each event starts with the maximum rate limit but can be reduced if necessary.

  • Rate Limit can be increased upon request.


Entities

There are two entities you can access using the API: APG players and Trivia Players. They are both nested under different URLs and have small parameter differences.

APG Player

Base URL: https://app.socialpoint.io/api/apg/players

Parameters:

-firstName: string, required

-lastName: string, required

-email: string, required, must be unique

-phone: string, optional, must be unique, must conform to E.164 standard

-pin: number, required

For more information on our APG Endpoints click here.

Trivia Player

Base URL: https://app.socialpoint.io/api/trivia/players

Parameters:

-firstName: string, required

-lastName: string, required

-email: string, required, must be unique

-pin: string, optional


HTTP Request Methods

These are the current request methods available to the API.

GET - Retrieve one or more entities

POST - Create new entity

PUT - Update existing entity

DELETE - Remove existing entity


HTTP Responses

You may already know all or at least some of them. Here's a list of some of the responses you will find when using the API.

  • 200 OK - Successfully retrieved or updated entity

  • 201 Created - Successfully created new entity

  • 204 No Content - Successfully deleted existing entity

  • 400 Bad Request - Unable to process request either due to invalid JSON or missing parameters

  • 401 Unauthorized - Missing or invalid API key

  • 403 Forbidden - API key lacks permission for the request

  • 404 Not Found - Unable to find the requested entity

  • 409 Conflict - Request contains a duplicate key value such as email or phone number

  • 429 Too Many Requests - Rate limit has been exceeded

  • 50X Server Error - Something went wrong on our end


Method Examples

Here is a quick example where the user wants to create a new player by using the POST request. All parameters are set correctly, so the response is a success.

Example Request:

POST https://app.socialpoint.io/api/apg/players
{
“firstName”: “Jim”,
“lastName”: “Maxwell”,
“email”: “jm@gmail.com”,
“phone”: “+12015551234”,
“pin”: 829294
}

Example Response:

HTTP/1.1 201 Created
{
“id”: 729873,
“firstName”: “Jim”,
“lastName”: “Maxwell”,
“email”: “jm@gmail.com”,
“phone”: “+12015551234”,
“pin”: 829294
}

Did this answer your question?