Internal API Documentation
Dokumentasi API internal Divisi IT — service endpoints, contract, dan integrasi
Dokumentasi ini mencakup API internal yang digunakan oleh service-service di lingkungan Divisi IT.
Base URL
| Environment | URL |
|---|---|
| Production | https://api.internal.it.trix.web.id |
| Staging | https://api-staging.internal.it.trix.web.id |
| Development | http://localhost:8080 |
Semua API menggunakan Bearer token untuk autentikasi.
Health Check
GET /health
Cek status service.
Response:
{
"status": "ok",
"uptime": 3600,
"version": "1.2.0",
"dependencies": {
"database": "connected",
"redis": "connected",
"rabbitmq": "connected"
}
}
Dokumen
GET /api/docs
List semua dokumen.
Response:
{
"data": [
{
"slug": "getting-started",
"title": "Onboarding Anggota Baru",
"updatedAt": "2026-06-05",
"team": "IT"
}
]
}
GET /api/docs/:slug
Ambil satu dokumen berdasarkan slug.
Parameters:
| Parameter | Tipe | Deskripsi |
|---|---|---|
slug | string | Path dokumen (e.g., dev/gitflow/branching) |
Response:
{
"data": {
"slug": "dev/gitflow/branching",
"title": "Branching Convention",
"content": "# Branching Convention...",
"html": "<h1>Branching Convention</h1>..."
}
}
Deployment
POST /api/deploy
Trigger deployment ke environment tertentu.
Request:
{
"service": "api-gateway",
"environment": "staging",
"version": "1.2.0",
"notify": ["@devops-team"]
}
Response:
{
"deploymentId": "dep-abc123",
"status": "queued",
"estimatedTime": 120
}
Monitoring
GET /api/metrics
Ambil metrics service.
Query Parameters:
| Parameter | Tipe | Default | Deskripsi |
|---|---|---|---|
service | string | all | Nama service |
from | ISO datetime | -1h | Rentang awal |
to | ISO datetime | now | Rentang akhir |
Response:
{
"service": "api-gateway",
"metrics": {
"requests_per_second": 150,
"p95_latency_ms": 45,
"error_rate": 0.02,
"cpu_usage": 65.5,
"memory_usage": 72.1
}
}