The APG API Endpoints follow the same criteria and parameters described in our SocialPoint API Documentation. If you haven't read it, click here to access it.

These are our current endpoints for APG:


APG Player

This endpoint allows you to add, edit, and remove players from an APG solution.

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

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
}


Staff-Scored Challenges

This endpoint allows you to add, edit or remove scores from Staff-Scored Challenges in your APG solution.

URL: unique to each challenge. Navigate to: Participation Game>Challenges and then click on your Challenge's name to see its URL.

Parameters

-playerEmail: Your player's email address, required.

-playerId: Created when the player registers, can be used instead of playerEmail, optional.

-points: This is the points value for the Staff Scored Challenge, required.

Example Request:

POST https://app.socialpoint.io/api/apg/challenges/1234/completed
{
“playerEmail”: “jm@gmail.com”,
“points”: 500
}

Example Response:

HTTP/1.1 200 OK
{
“id”:”251515”,
“playerId”: “729873”,
“challengeId”: “1234”,
“playerEmail”: “jm@gmail.com”,
“points”: 500
}

Did this answer your question?