API versioning and changes
Distinguish the API contract from the application version and follow documentation changes.
Last updated:
API and application versions
The external integration contract is available under /api/v1. The response header X-GIS-API-Surum: 1 identifies that contract's version. X-GIS-Surum identifies the responding application version; it need not match the API version. Read your installation's actual value from the response header.
Public release notes use date-based names. The page label 2026.11 / November 2026 does not assert that the application header necessarily returns 2026.11. Recording the header value in integration logs without sensitive information helps identify which application version exhibited a behaviour.
Stable field names
Turkish API field names are stable throughout the version. Do not send your own translations of fields such as kod, alan, kapsam or gizli. Interface labels may differ from JSON keys; use the field glossary and endpoint schema for requests and responses.
Clients should ignore unfamiliar additional response fields, but treat missing required fields or changed types as errors. Use the HTTP status and, where present, kod for business logic rather than matching the wording of an error description.
Assessing changes
Adding an optional field or a new endpoint may allow existing integrations to continue unchanged. Removing a field, changing its name or type, or changing its established meaning is an incompatible change for an integration. Compare your installation's schema with the current documentation before using a new response field.
No numeric deprecation notice period or future release date is promised here. Organisation-specific update terms belong in the relevant agreement. Cookie-authenticated /api endpoints form the browser application's contract; do not assume they offer the same versioning assurance as v1.
Documentation changelog
| Date | Scope | Change |
|---|---|---|
| November 2026 | v1 documentation | Added a quick start, identity and scope explanations, field and error glossaries, and source-checked request/response examples. |
| November 2026 | API reference | Separated v1, OGC and application groups into individual pages. |
| November 2026 | Webhook documentation | Added an event catalogue, signature examples and a fixed verification vector. |
This table records documentation changes; it does not mean a new product endpoint was released or live acceptance completed on that date. Read the installation schema with GET /api/v1/openapi.json. The site's downloadable v1 schema is a schema copy maintained with the site.
