API

Cipta dan urus pautan pendek daripada skrip dan aplikasi. API ini percuma. Cipta kunci dalam papan pemuka anda di bawah Kunci API, kemudian hantarkannya sebagai token bearer.

Pengesahan

Authorization: Bearer gz_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Kunci hanya ditunjukkan sekali. Anggaplah ia seperti kata laluan: sesiapa yang memiliki kunci anda boleh mencipta dan menyunting pautan dalam akaun anda. Batalkan kunci yang bocor melalui papan pemuka.

Had

60 permintaan seminit bagi setiap kunci.
500 pautan baharu sehari bagi setiap akaun.
Destinasi disemak dengan Google Safe Browsing dan senarai sekatan kami. Pemendek pautan lain tidak boleh digunakan sebagai destinasi.

Cipta pautan

curl -X POST https://gozi.to/api/my/links \
  -H "Authorization: Bearer $GOZI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/launch", "code": "launch"}'

code adalah pilihan (4–32 huruf, nombor, - atau _). Tinggalkan kosong untuk kod rawak 7 aksara. Respons 201:

{
  "link": {
    "code": "launch",
    "shortUrl": "https://gozi.to/launch",
    "url": "https://example.com/launch",
    "status": "active",
    "statusReason": null,
    "custom": true,
    "createdAt": 1790000000000,
    "expiresAt": null
  }
}

Senaraikan pautan

GET /api/my/links?limit=25&cursor=<nextCursor>&q=<search>&clicks=1

Terbaharu dahulu. Hantar nextCursor daripada halaman sebelumnya untuk mendapatkan halaman seterusnya. clicks=1 menambah jumlah klik manusia sepanjang masa.

Dapatkan, sunting, padam

GET    /api/my/links/{code}
PATCH  /api/my/links/{code}   {"url": "https://new.example"}  or  {"status": "disabled" | "active"}
DELETE /api/my/links/{code}

Analitik

GET /api/my/links/{code}/stats

Mengembalikan klik manusia untuk 90 hari terakhir dan sepanjang masa, klik setiap hari, serta negara, perujuk, peranti, pelayar dan sistem pengendalian teratas. Bot dan pratonton pautan (Slack, WhatsApp, dan sebagainya) dikira berasingan dalam botClicks. Keputusan disimpan dalam cache selama kira-kira 5 minit.

Ralat

Ralat menggunakan kod status HTTP dan badan JSON:

{ "error": { "code": "slug_taken", "message": "That custom link is already taken." } }

400 input tidak sah (invalid_url, invalid_slug, …)
401 kunci hilang, tidak sah atau telah dibatalkan
409 pautan tersuai sudah digunakan
422 destinasi tidak dibenarkan (destination_blocked)
429 had kadar atau had harian telah dicapai

Penerangan setiap titik akhir yang boleh dibaca mesin ada di /openapi.json.