Tautan

Ambil semua

Titik Akhir

GET https://heo.li/api/links/

Contoh

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

Parameter	Rincian	Deskripsi
search	Opsional String	String pencarian.
search_by	Opsional String	Bidang apa yang Anda cari. Nilai yang diizinkan adalah: `url`, `location_url`.
is_enabled	Opsional Boolean
project_id	Opsional Bilangan bulat
domain_id	Opsional Bilangan bulat
type	Opsional String	`biolink`, `link`, `file`, `vcard`, `event`, `static`
datetime_field	Opsional String	Nilai yang diizinkan: `datetime`, `last_datetime`
datetime_start	Opsional String	Filter hasil mulai dari tanggal waktu ini. format `Y-m-d H:i:s`.
datetime_end	Opsional String	Saring hasil hingga tanggal dan waktu ini. format `Y-m-d H:i:s`.
order_by	Opsional String	Bidang apa untuk mengurutkan hasil. Nilai yang diizinkan adalah: `link_id`, `datetime`, `last_datetime`, `clicks`, `url`.
order_type	Opsional String	Urutan hasil. Nilai yang diizinkan adalah: `ASC` untuk urutan naik, dan `DESC` untuk urutan turun.
page	Opsional Bilangan bulat	Nomor halaman yang Anda inginkan hasilnya. Default ke `1`.
results_per_page	Opsional Bilangan bulat	Berapa banyak hasil yang Anda inginkan per halaman. Nilai yang diizinkan adalah: `10`, `25`, `50`, `100`, `250`, `500`, `1000`. Default ke `25`.

Contoh tanggapan

{
    "data": [
        {
            "id": 1,
            "project_id": null,
            "domain_id": 0,
            "type": "link",
            "url": "example",
            "location_url": "https://example.com/",
            "settings": {
                "password": null,
                "sensitive_content": false
            },
            "clicks": 10,
            "order": 0,
            "start_date": null,
            "end_date": null,
            "datetime": "2026-04-22 22:13:02",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://heo.li/api/links?page=1",
        "last": "https://heo.li/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://heo.li/api/links?page=1"
    }
}

Ambil satu

Titik Akhir

GET https://heo.li/api/links/{link_id}

Contoh

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

Contoh tanggapan

{
    "data": {
        "id": 1,
        "project_id": null,
        "domain_id": 0,
        "type": "link",
        "url": "example",
        "location_url": "https://example.com/",
        "settings": {
            "password": null,
            "sensitive_content": false
        },
        "clicks": 10,
        "order": 0,
        "start_date": null,
        "end_date": null,
        "datetime": "2026-04-22 22:13:02",
    }
}

Parameter	Rincian	Deskripsi
type	Opsional String	`link`
location_url	Diperlukan String	URL tujuan.Tersedia ketika: is_bulk = 0
location_urls	Diperlukan String	URL tujuan.Tersedia ketika: is_bulk = 1
url	Opsional String	Alias URL dari tautan yang dihasilkan. Biarkan kosong untuk menghasilkan secara acak.Tersedia ketika: is_bulk = 0
is_bulk	Opsional Boolean
domain_id	Opsional Bilangan bulat	-
project_id	Opsional Bilangan bulat	-
pixels_ids	Opsional Array Bilangan bulat	-
email_reports	Opsional Array	ID penangan notifikasi
schedule	Opsional Boolean	-
start_date	Opsional String	Tersedia ketika: schedule = true
end_date	Opsional String	Tersedia ketika: schedule = true
clicks_limit	Opsional Bilangan bulat	-
expiration_url	Opsional String	-
sensitive_content	Opsional Boolean	-
http_status_code	Opsional Bilangan bulat	Nilai yang diizinkan: `301`, `302`, `307`, `308`
app_linking_is_enabled	Opsional Boolean	-
cloaking_is_enabled	Opsional Boolean	-
cloaking_title	Opsional String	-
cloaking_meta_description	Opsional String	-
cloaking_custom_js	Opsional String	-
cloaking_favicon	Opsional Berkas	-
cloaking_opengraph	Opsional Berkas	-
password	Opsional String	-
forward_query_parameters_is_enabled	Opsional Boolean	-
seo_block	Opsional Boolean	-
utm_source	Opsional String	-
utm_medium	Opsional String	-
utm_campaign	Opsional String	-
targeting_type	Opsional String	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	Opsional String	Tersedia ketika: targeting_type = continent_code
targeting_continent_code_value[index]	Opsional String	Tersedia ketika: targeting_type = continent_code
targeting_country_code_key[index]	Opsional String	Tersedia ketika: targeting_type = country_code
targeting_country_code_value[index]	Opsional String	Tersedia ketika: targeting_type = country_code
targeting_city_name_key[index]	Opsional String	Tersedia ketika: targeting_type = city_name
targeting_city_name_value[index]	Opsional String	Tersedia ketika: targeting_type = city_name
targeting_device_type_key[index]	Opsional String	Tersedia ketika: targeting_type = device_type
targeting_device_type_value[index]	Opsional String	Tersedia ketika: targeting_type = device_type
targeting_browser_language_key[index]	Opsional String	Tersedia ketika: targeting_type = browser_language
targeting_browser_language_value[index]	Opsional String	Tersedia ketika: targeting_type = browser_language
targeting_rotation_key[index]	Opsional String	Tersedia ketika: targeting_type = rotation
targeting_rotation_value[index]	Opsional String	Tersedia ketika: targeting_type = rotation
targeting_os_name_key[index]	Opsional String	Tersedia ketika: targeting_type = os_name
targeting_os_name_value[index]	Opsional String	Tersedia ketika: targeting_type = os_name
targeting_browser_name_key[index]	Opsional String	Tersedia ketika: targeting_type = browser_name
targeting_browser_name_value[index]	Opsional String	Tersedia ketika: targeting_type = browser_name

curl --request POST \
--url 'https://heo.li/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://heo.li/' \

Contoh tanggapan

{
    "data": {
        "id": 1
    }
}

Perbarui

Titik Akhir

POST https://heo.li/api/links/{link_id}

Parameter	Rincian	Deskripsi
location_url	Opsional String	URL tujuan.
url	Opsional String	Alias URL dari tautan yang dihasilkan. Biarkan kosong untuk menghasilkan secara acak.
domain_id	Opsional Bilangan bulat	-
project_id	Opsional Bilangan bulat	-
pixels_ids	Opsional Array Bilangan bulat	-
email_reports	Opsional Array	ID penangan notifikasi
schedule	Opsional Boolean	-
start_date	Opsional String	Tersedia ketika: schedule = true
end_date	Opsional String	Tersedia ketika: schedule = true
clicks_limit	Opsional Bilangan bulat	-
expiration_url	Opsional String	-
sensitive_content	Opsional Boolean	-
http_status_code	Opsional Bilangan bulat	Nilai yang diizinkan: `301`, `302`, `307`, `308`
app_linking_is_enabled	Opsional Boolean	-
cloaking_is_enabled	Opsional Boolean	-
cloaking_title	Opsional String	-
cloaking_meta_description	Opsional String	-
cloaking_custom_js	Opsional String	-
cloaking_favicon	Opsional Berkas	-
cloaking_opengraph	Opsional Berkas	-
password	Opsional String	-
forward_query_parameters_is_enabled	Opsional Boolean	-
seo_block	Opsional Boolean	-
utm_source	Opsional String	-
utm_medium	Opsional String	-
utm_campaign	Opsional String	-
targeting_type	Opsional String	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	Opsional String	Tersedia ketika: targeting_type = continent_code
targeting_continent_code_value[index]	Opsional String	Tersedia ketika: targeting_type = continent_code
targeting_country_code_key[index]	Opsional String	Tersedia ketika: targeting_type = country_code
targeting_country_code_value[index]	Opsional String	Tersedia ketika: targeting_type = country_code
targeting_city_name_key[index]	Opsional String	Tersedia ketika: targeting_type = city_name
targeting_city_name_value[index]	Opsional String	Tersedia ketika: targeting_type = city_name
targeting_device_type_key[index]	Opsional String	Tersedia ketika: targeting_type = device_type
targeting_device_type_value[index]	Opsional String	Tersedia ketika: targeting_type = device_type
targeting_browser_language_key[index]	Opsional String	Tersedia ketika: targeting_type = browser_language
targeting_browser_language_value[index]	Opsional String	Tersedia ketika: targeting_type = browser_language
targeting_rotation_key[index]	Opsional String	Tersedia ketika: targeting_type = rotation
targeting_rotation_value[index]	Opsional String	Tersedia ketika: targeting_type = rotation
targeting_os_name_key[index]	Opsional String	Tersedia ketika: targeting_type = os_name
targeting_os_name_value[index]	Opsional String	Tersedia ketika: targeting_type = os_name
targeting_browser_name_key[index]	Opsional String	Tersedia ketika: targeting_type = browser_name
targeting_browser_name_value[index]	Opsional String	Tersedia ketika: targeting_type = browser_name

Contoh

curl --request POST \
--url 'https://heo.li/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Contoh tanggapan

{
    "data": {
        "id": 1
    }
}

Hapus

Titik Akhir

DELETE https://heo.li/api/links/{link_id}

Contoh

curl --request DELETE \
--url 'https://heo.li/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Tautan

Ambil semua

Ambil satu

Buat

Perbarui

Hapus