Getting Started

This documentation assumes you have working knowledge of HTTP requests and JSON. If you need to brush up on these concepts, we recommend reviewing them before proceeding.

API Base URL

All requests should be sent to our API server:

https://app.playmanity.net/api

Integration Flow

The Playmanity API follows a sequential flow that must be respected for successful implementation:

1. Authentication: Verify the user's identity and obtain an authentication token
2. Session Management: Create and maintain an active game session
3. Advertisement Delivery: Request and display advertisements during gameplay
4. Session Termination: Properly end the session when the player exits

Important Notes

• Advertisements cannot be displayed without an active session
• Sessions cannot be created without proper authentication
• Authentication tokens must be included with all subsequent requests
• Sessions must be maintained with regular heartbeat requests

Each section of this documentation provides detailed information about the endpoints, required parameters, and expected responses for each step in the integration process.

Example Implementation Sequence

1. Call /games/auth/initiate with your game_uuid
2. Redirect user to the provided auth_url
3. Poll /games/auth/status/[auth_id] until authentication is complete
4. Use the received auth_token to create a session with /games/sessions/initiate
5. Send heartbeat requests every 30 seconds to maintain the session
6. Request advertisements as needed with /advertisements
7. End the session properly with /games/sessions/end when the player exits

The following sections provide detailed information for implementing each step.