Ana içeriğe geç

API Dokümantasyon Kılavuzu

Taz SaaS Platformunun RESTful API endpoint'leri aşağıdaki servisler arasında organize edilmiştir. Tüm endpoint'ler JWT Bearer Token authentication gerektirir (belirtilenler hariç).

Servislerin Genel Bakış

ServisBase RouteAuthenticationEndpoint Sayısı
Identity/api/auth, /api/users, /api/tenantsRequired (Auth)~26
ContentService/api/content/admin, /api/content/sitesRequired / None~40
BCM Service/api/bcm/admin/*Required (Auth)~27
AI Agent/api/ai/agents, /api/ai/*Required (Auth)~26
AI Conversation/api/conversations/*Required (Auth)~11
AI Knowledge/api/knowledge/*Required (Auth)~10
AI LLM Gateway/api/llm-gateway/*Required / None~8
AI Prompt/api/prompts/*Required (Auth)~9
AI Tool Registry/api/tools/*Required (Auth)~6
AI Analytics/api/analytics/*Required (Auth)~2
AI Connector/api/proactive-messages, /api/webhooks/*Varies~8
Payment/api/subscriptions, /api/payments, /api/invoicesRequired (Auth)~17
Vault Service/api/secrets/*InternalAPI Key~5

Authentication

Bearer Token (JWT)

Tüm endpoint'ler Authorization header ile JWT token gerektirir:

Authorization: Bearer eyJhbGciOiJSUzI1NiIs...

Token POST /api/auth/login veya POST /api/auth/refresh-token endpoint'lerinden alınır.

InternalAPI Key

Vault ve bazı internal routing endpoint'leri özel API key gerektirir:

X-Internal-Api-Key: <vault-generated-key>

Common Response Format

Tüm endpoint'ler tutarlı response formatı kullanır:

Success (200 OK)

{
"success": true,
"result": { ... }
}

Error (4xx/5xx)

{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Açıklayıcı hata mesajı"
}
}

Pagination Pattern

Listeleme endpoint'leri sayfalama desteği verir:

{
"items": [...],
"totalCount": 150,
"totalPages": 8,
"page": 1,
"pageSize": 20
}

Rate Limiting

Endpoint GrubuLimit
Auth (login/register)5 req/min / IP
Content forms60 req/min / IP
Widget sessions60 req/min / IP
OAuth/OTP verification5 req/15min / IP

Base URLs

OrtamURL
Productionhttps://app.taztechnology.com/api
Local Devhttp://localhost:5000/api