Newgrounds Flash API: Difference between revisions

From Flashpoint Datahub
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
'''Newgrounds''' is a large Flash-based content platform that historically provided multiple HTTP Web API versions to support online game functionality, including scoreboards and medals. Over time, these APIs evolved to accommodate new features and architectural changes.
'''Newgrounds''' is a large Flash-based content platform that historically provided multiple HTTP Web API versions to support online game functionality, including scoreboards and medals. Over time, these APIs evolved to accommodate new features and architectural changes.


This article documents the known API versions and their usage within the Flashpoint ecosystem.
This article documents the known API versions and their usage within the Flashpoint.
 
'''TL;DR:'''
 
* v1 and v2 API endpoints are routed through the legacy router as part of the standard Flashpoint installation.
 
* v3 requires per-game configuration.


== API Versions ==
== API Versions ==
Line 35: Line 41:
* '''Endpoint:''' <code>www.newgrounds.io/gateway_v3.php</code>
* '''Endpoint:''' <code>www.newgrounds.io/gateway_v3.php</code>
* '''Protocol:''' HTTP
* '''Protocol:''' HTTP
* '''Purpose:''' New modernized API
* '''Purpose:''' New modernized API. This API is documented on Newgrounds website: https://www.newgrounds.io/help/components
 
Each game uses a unique '''Application ID''', and the corresponding <code>gateway_v3.php</code> must be created per game. There is no universal file like v1 or v2.


== Implementation Notes ==
Each game uses a unique '''Application ID''', and the corresponding <code>gateway_v3.php</code> must be created per game. There is no universal file like v1 or v2
* v1 and v2 endpoints are routed through the legacy router as part of the standard Flashpoint installation.
* v3 requires per-game setup due to its application-specific authentication model.

Latest revision as of 18:56, 14 February 2026

Newgrounds HTTP API Versions

Overview

Newgrounds is a large Flash-based content platform that historically provided multiple HTTP Web API versions to support online game functionality, including scoreboards and medals. Over time, these APIs evolved to accommodate new features and architectural changes.

This article documents the known API versions and their usage within the Flashpoint.

TL;DR:

  • v1 and v2 API endpoints are routed through the legacy router as part of the standard Flashpoint installation.
  • v3 requires per-game configuration.

API Versions

v1 API

  • Endpoint: www.ngads.com/gateway.php
  • Protocol: HTTP
  • Purpose: Early implementation. Does not updating.

This endpoint is implemented in the legacy router:

  • Repository Location:
 Legacy/cgi-bin/www.ngads.com/gateway.php
  • Source:
 https://gitlab.unstable.life/flashpoint/components/core/legacy-router/-/blob/main/Legacy/cgi-bin/www.ngads.com/gateway.php?ref_type=heads

v2 API

  • Endpoint: www.ngads.com/gateway_v2.php
  • Protocol: HTTP
  • Purpose: Revised version of the API with expanded functionality supporting per game implementation

This endpoint is implemented in the legacy router:

  • Repository Location:
 Legacy/cgi-bin/www.ngads.com/gateway_v2.php
  • Source:
 https://gitlab.unstable.life/flashpoint/components/core/legacy-router/-/blob/main/Legacy/cgi-bin/www.ngads.com/gateway_v2.php?ref_type=heads

v3 API

Each game uses a unique Application ID, and the corresponding gateway_v3.php must be created per game. There is no universal file like v1 or v2