Dokumentasi API

Ini adalah dokumentasi untuk endpoint API yang tersedia, yang dibangun di sekitar arsitektur REST. Semua endpoint API akan mengembalikan respons JSON dengan kode respons HTTP standar dan memerlukan Otentikasi Bearer melalui Kunci API.

Dapatkan Kunci API Anda sendiri

URL Dasar

Otentikasi

Semua endpoint API memerlukan kunci API yang dikirim dengan metode Autentikasi Bearer.

Authorization: Bearer {api_key}

Contoh

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

Kesalahan

API kami menggunakan kode status HTTP konvensional untuk menunjukkan keberhasilan atau kegagalan suatu permintaan.

Contoh

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

Kode status

200 Permintaan berhasil diselesaikan

400 Permintaan buruk - Parameter yang diperlukan hilang atau tidak valid

401 Tidak sah - kunci API tidak ada atau tidak valid

404 Sumber daya yang diminta tidak ditemukan

429 Terlalu banyak permintaan - Batas laju terlampaui

500 Kesalahan server internal - ini berarti ada masalah di pihak kami

Semua hasil endpoint API bekerja dengan zona waktu UTC kecuali ditentukan lain.

Pengguna

Tautan

Statistik tautan

Proyek

Piksel

Halaman pembuka

Kode QR

Data

Penangan notifikasi

Domain kustom

Pembayaran akun

Log akun