GeoCordon

Documentation Portal

Version 1.0.0-rc.1

Audience: Application developers and integration teams.

Developers

API v1, OpenAPI, authentication, permissions, client, CLI, integration examples, and error model.

Guide

API v1

Developer APIs are rooted at `/api/v1` and reuse administrator sessions, RBAC permissions, commercial entitlements, and safe error envelopes.

Core Workflows

Use API health and version discovery, policy validation, Country and Industry Intelligence lookups, operations snapshots, and audit status checks from local clients.

Client and CLI

The Go client and `gcdev` CLI are local helpers for customer-operated deployments. They do not add API keys, hosted callbacks, remote search, or telemetry.

Authoritative Sources

These repository documents remain the source of truth for implementation details.

Developer Platform

API v1 endpoints, error model, Go client, CLI, and local workflow.

docs/DEVELOPER_PLATFORM.md

GeoCordon CP-5 exposes a small, stable developer surface for customer-operated integrations. It is local-first, versioned under `/api/v1`, and reuses the existing administrator session, RBAC, licensing, entitlement, and safe-response boundaries.

API versioning

API compatibility and versioning policy.

docs/API_VERSIONING.md

Stable platform contracts for GeoCordon admin/compliance HTTP APIs and related public operator surfaces.

Developer client

Minimal local Go client package.

backend/pkg/developerclient

Minimal local Go client package.

Developer examples

Local policy validation example files.

examples/developer-platform

Local policy validation example files.

OpenAPI Reference

A running GeoCordon gateway exposes the machine-readable Developer API document at /api/v1/openapi.json. The portal links to that local endpoint rather than maintaining a second copy of API schemas.