API гарын авлага ​

Та API ашиглсанаар byl системд өөрийн програмаа хялбархан холбох боломжтой юм.

API endpoints ​

Byl-ийн бүх API endpoint-ууд https://byl.mn/api хаягаар эхлэх бөгөөд REST стандартын дагуу ажиллах болно.

API дуудах http method-ууд:

  • GET - GET хүсэлтүүд серверээс өгөгдөл авхад ашиглагдах бөгөөд зөвхөн унших үйлдлийг хийнэ.
  • POST - POST хүсэлт өгөгдөл шинээр үүсгэхэхд ашиглагдана. Жш: нэхэмлэх үүсгэх гэх мэт...
  • DELETE - DELETE хүсэлт өгөгдөл устгахад ашиглагдах бөгөөд зарим нэг цуцлах, идэвхүй болгох зэрэг үйлдэлд ашиглагдана.
  • PUT - PUT хүсэлтүүд өгөгдөл засварлахад ашиглагдана.

Response ​

Бүх byl API-с бүцах утга JSON форматтай байна.

Дараахь жишээ POST: /api/v1/projects/1/invoices бүхий нэхэмжлэх үүсгэх endpoint-ийн буцах утгыг харна уу.

json
{
  "data": {
    "status": "draft",
    "amount": 10,
    "description": "Test invoice",
    "project_id": 1,
    "updated_at": "2023-06-24T05:27:42.000000Z",
    "created_at": "2023-06-24T05:27:42.000000Z",
    "id": 3
  }
}

Төсөл ​

Тухайн нэг төсөлийн хүрээнд ашиглагдах API endpoint ууд бүгд /api/v1/projects/:id хаягаар эхлэнэ. Жишээ нь: GET: /api/v1/projects/1 болон POST: /api/v1/projects/1/invoices гэх мэт.

:id нь төсөлийн дугаарыг илэрхийлэх бөгөөд веб хуудасны төслийн тохиргоо цэснээс харах боломжтой.

Byl Project ID