API Reference

Allmine API reference Fumadocs OpenAPI playground uzerinden uretilir. Endpoint sayfalarinda request builder, auth alani, response semalari ve otomatik kod ornekleri bulunur.

Bolumler

API reference tek buyuk endpoint listesi yerine amaca gore ayrilmis OpenAPI dosyalariyla yayinlanir.

Admin, webhook, test, inspect, Slack, Figma ve internal browser endpointleri public/client referanstan ayrilir; bunlar Internal API tab'i altinda yayinlanir.

Test Ortamlari

Playground varsayilan olarak Development API'yi one alir. Mutasyon yapan endpointleri denerken production server secmeyin.

| Ortam | Base URL | Kullanim | | --- | --- | | Development | https://dev-api.allminelive.com | Dokuman uzerinden test icin onerilen ortam | | Staging | https://staging-api.allminelive.com | Release oncesi dogrulama | | Production | https://api.allminelive.com | Sadece kontrollu okuma veya gercek operasyon | | Local | http://localhost:4000 | Lokal backend calisirken |

Auth

JWT isteyen endpointlerde playground sag panelindeki auth alanina access token'i yalniz token olarak girin.

Authorization: Bearer <access_token>

Header alanina Bearer prefix'i elle eklemeniz gerekmez; Fumadocs security scheme bunu otomatik uygular.

Test token alma akisi icin Test JWT Nasil Alinir? rehberini kullanin. Bu dokumanda gercek veya ornek JWT degeri tutulmaz.

Production Uyarilari

POST, PUT, PATCH ve DELETE endpointlerinin aciklamasina otomatik production uyarisi eklenir. Production server gorunur olsa bile test requestleri icin Development server secili kalmalidir.

Kullanım

1. Sol menuden Public API veya Mobile App API altindaki endpointi acin.
2. Server olarak Development secili degilse Development'a alin.
3. Gerekiyorsa auth alanina JWT access token girin.
4. Path, query, header ve body alanlarini doldurun.
5. Try it ile request'i gonderin.

OpenAPI Kaynagi

Docs build'i repo icindeki filtrelenmis statik OpenAPI dosyalarini kullanir:

docs/openapi/allmine-api.json
docs/openapi/public-api.json
docs/openapi/mobile-app-api.json
docs/openapi/admin-api.json
docs/openapi/webhooks.json
docs/openapi/internal-ops-api.json

Backend Swagger dokumani degistikce bu dosyalari guncelleyin:

npm run docs:openapi:sync
npm run docs:validate

Varsayilan sync kaynagi:

https://dev-api.allminelive.com/swagger/all-json

Farkli bir kaynaktan cekmek icin:

OPENAPI_SOURCE_URL=https://staging-api.allminelive.com/swagger/all-json npm run docs:openapi:sync