Dokumentasi API

Ketahui cara menyambung dan menyepadukan dengan API kami.

Dapatkan Kunci API anda sendiri

URL asas

Pengesahan

Semua titik akhir API memerlukan kunci API yang dihantar oleh kaedah Pengesahan Pembawa.

Authorization: Bearer {api_key}

Contoh

curl --request GET \
--url 'https://mybotsy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

API kami menggunakan kod status HTTP konvensional untuk menunjukkan kejayaan atau kegagalan permintaan.

Contoh

{
    "errors": [
        {
            "title": "Anda tidak mempunyai akses kepada API.",
            "status": 401
        }
    ]
}

Kod status

200 Permintaan berjaya diselesaikan

400 Permintaan buruk - Parameter yang diperlukan tiada atau tidak sah

401 Tidak dibenarkan - Kunci API tiada atau tidak sah

404 Sumber yang diminta tidak ditemui

429 Terlalu banyak permintaan - Had kadar melebihi

500 Ralat pelayan dalaman - ini bermakna terdapat masalah di pihak kami

Semua hasil titik akhir API berfungsi dengan zon waktu UTC melainkan dinyatakan sebaliknya.

Pengguna

Pasukan

Ahli pasukan

Log akaun