Nyaraka za API

Fupisha viungo moja kwa moja kutoka kwenye msimbo wako. Endpoint moja, tokeni moja ya bearer.

Endpoint

POSThttps://za.gl/api/shorten

RESTMwili wa JSONUthibitishaji wa bearer

Uthibitishaji

Pitisha tokeni yako ya API kwenye kichwa Authorization kama tokeni ya bearer. Ichukue kwenye dashibodi ya akaunti yako baada ya kutengeneza kiungo chako cha kwanza.

Kichwa

Authorization: Bearer YOUR_API_TOKEN

Huna tokeni bado? Unaweza kuita endpoint bila tokeni. Za.gl hutengeneza akaunti isiyojulikana papo hapo na kurudisha tokeni mpya katika data.newAuthToken. Ihifadhi ili udhibiti viungo vyako baadaye.

Mwili wa ombi

Sehemu	Aina	Maelezo
`originalUrl`inahitajika	string	URL ndefu ya kufupishwa. Ukiacha protokali, https:// huongezwa kwa ajili yako.
`customAlias`	string	Mwisho wako mwenyewe, mf. za.gl/my-link. Lazima uwe wa kipekee, la sivyo utapata 409.
`password`	string	Linda kiungo ili wageni wahitaji nenosiri kuendelea.
`expiresAt`	string (ISO date)	Wakati kiungo kinapaswa kuacha kufanya kazi. Lazima uwe wa baadaye.
`expiresInMinutes / expiresInHours / expiresInDays`	number	Mbadala wa expiresAt, kiishe baada ya muda fulani.
`waitTimer`	number (0-300)	Sekunde ambazo mgeni husubiri kwenye ukurasa wa hakikisho kabla ya kuelekezwa.
`customGtmId`	string	Kitambulisho chako cha Google Tag Manager (GTM-XXXXXXX) kinachowashwa kwenye ukurasa wa hakikisho.
`title / description`	string	Metadata ya hiari inayohifadhiwa pamoja na kiungo.
`generateQR`	boolean	Rudisha pia msimbo wa QR wa URL fupi.

originalUrlinahitajika

string

URL ndefu ya kufupishwa. Ukiacha protokali, https:// huongezwa kwa ajili yako.

customAlias

string

Mwisho wako mwenyewe, mf. za.gl/my-link. Lazima uwe wa kipekee, la sivyo utapata 409.

password

string

Linda kiungo ili wageni wahitaji nenosiri kuendelea.

expiresAt

string (ISO date)

Wakati kiungo kinapaswa kuacha kufanya kazi. Lazima uwe wa baadaye.

expiresInMinutes / expiresInHours / expiresInDays

number

Mbadala wa expiresAt, kiishe baada ya muda fulani.

waitTimer

number (0-300)

Sekunde ambazo mgeni husubiri kwenye ukurasa wa hakikisho kabla ya kuelekezwa.

customGtmId

string

Kitambulisho chako cha Google Tag Manager (GTM-XXXXXXX) kinachowashwa kwenye ukurasa wa hakikisho.

title / description

string

Metadata ya hiari inayohifadhiwa pamoja na kiungo.

generateQR

boolean

Rudisha pia msimbo wa QR wa URL fupi.

Mfano wa ombi

POSTcURL

curl -X POST https://za.gl/api/shorten \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "originalUrl": "https://example.com/a-very-long-link",
    "customAlias": "my-link",
    "password": "optional-secret",
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "waitTimer": 5
  }'

Mfano wa jibu

Ombi lililofanikiwa hurudisha 200 OK yenye URL fupi katika data.shortUrl.

200 OKJSON

{
  "success": true,
  "message": "URL shortened successfully",
  "data": {
    "id": "123",
    "alias": "my-link",
    "shortUrl": "https://za.gl/my-link",
    "originalUrl": "https://example.com/a-very-long-link",
    "customAlias": "my-link",
    "domain": "za.gl",
    "title": "",
    "description": null,
    "hasPassword": true,
    "isActive": true,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "hits": 0,
    "waitTimer": 5,
    "created": "2026-06-25T10:00:00.000Z",
    "modified": "2026-06-25T10:00:00.000Z",
    "authToken": "your-account-token"
  }
}

Vikomo vya maombi na hitilafu

10 req/minHadi maombi 10 kwa dakika kwa kila mteja.

409Alias uliyochagua tayari imechukuliwa.

400URL batili au tarehe ya kuisha iliyopita.

429Umefikia kikomo cha maombi au kiasi chako cha mwezi.