GOON PLATFORM API

Infrastructure for intelligent mobility.

Build applications on top of the secure, scalable infrastructure powering the GOON mobility ecosystem.

VERSION v1
BASE URL /api/v1
FORMAT JSON
01
GETTING STARTED

Make your first request.

The GOON API uses standard HTTP requests and JSON responses. Authenticate your application and start interacting with platform services.

REQUEST
curl /api/v1/health
RESPONSE 200 OK
{
  "status": "ok",
  "service": "goon-api",
  "version": "v1"
}
02
AUTHENTICATION

Secure by default.

Protected API resources require authentication. Credentials and tokens should never be exposed in client-side source code.

🔐
Authentication required

Authenticated requests are validated before reaching protected platform resources.

03
API REFERENCE

Platform resources.

Explore the primary resources exposed through the GOON Platform API.

A

Authentication

Manage authentication and sessions.

POST /api/v1/auth/login Authenticate a user. →
POST /api/v1/auth/refresh Refresh authentication credentials. →
C

Customers

Customer profiles and account data.

GET /api/v1/customer/profile Get the authenticated customer. →
PATCH /api/v1/customer/profile Update customer information. →
D

Drivers

Driver accounts and operational data.

GET /api/v1/driver/profile Get the authenticated driver. →
R

Rides

Ride lifecycle and trip management.

POST /api/v1/rides Create a ride request. →
GET /api/v1/rides/{id} Retrieve ride information. →
$

Payments

Payment and transaction resources.

GET /api/v1/payments/{id} Retrieve payment information. →
04
REAL-TIME

Events without polling.

GOON uses Symfony Mercure to deliver real-time updates to connected applications.

Customer
Mercure
Driver
ride.updated Ride state changed
driver.location.updated Driver location changed
ride.assigned Driver assigned to ride
05
PLATFORM

Built as infrastructure.

The platform combines Symfony 8.4, MySQL, Redis and Mercure into a unified backend foundation.

PHP 8.4 Runtime
Symfony 8.4 Framework
MySQL Database
Redis Cache
Mercure Real-time
06
SECURITY

Security is a boundary.

Authentication, authorization and application isolation are fundamental parts of the platform architecture.

07
API VERSIONS

Designed to evolve.

API versions are explicitly namespaced so new platform capabilities can be introduced without unexpectedly breaking existing integrations.

CURRENT v1
Active