დეველოპერებისთვის

API დოკუმენტაცია

ქვემოთ მოცემულია API-ის სტრუქტურა, ავტორიზაცია და მოთხოვნების მაგალითები.

ავტორიზაცია

API-ის გამოყენებისთვის საჭიროა Token ან გასაღები, რომელიც იგზავნება მოთხოვნის Header-ში.

Authorization: Bearer YOUR_API_TOKEN

მოთხოვნის მაგალითი

ქვემოთ არის ზოგადი მოთხოვნის მაგალითი.

GET /api/client/servers
Host: api.cshost.ge
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json

JSON პასუხის მაგალითი

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "CS 1.6 Public Server",
      "status": "running"
    }
  ]
}

შეცდომების ტიპები

კოდი მნიშვნელობა აღწერა
400 Bad Request მოთხოვნა არასწორადაა ფორმირებული
401 Unauthorized ავტორიზაცია არასწორია ან აკლია
403 Forbidden წვდომა აკრძალულია
404 Not Found მოთხოვნილი რესურსი არ მოიძებნა
500 Server Error სერვერზე დაფიქსირდა შიდა შეცდომა
რეალური Endpoint-ები და ველები შეგიძლიათ შეცვალოთ თქვენი API-ის საბოლოო სტრუქტურის მიხედვით.