GET/v1/catalog/services/{service_id}/icon

Dapatkan ikon layanan

get_catalog_service_icon

Mengembalikan ikon layanan: WebP 128×128 dengan latar belakang transparan yang disertakan bersama Sursa. Respons tidak pernah berubah: Cache-Control: public, max-age=31536000, immutable, dan ETag menggabungkan versi katalog dan ID (kirim di If-None-Match untuk mendapatkan 304). Parameter v (versi katalog, sudah disertakan di icon_url) memisahkan versi di cache peramban. Untuk entri tanpa ikon (icon: false), endpoint ini mengembalikan 404 catalog.icon_not_found, dan antarmuka menampilkan inisial. Jika instalasi menyajikan ikon dari alamat eksternal, icon_url mengarah ke sana, dan endpoint ini tetap tersedia.

Autentikasi

Kirim kunci API di header Authorization: Authorization: Bearer <kunci>.

Parameter path

service_idstring (uuid)wajib
ID entri katalog layanan (UUID).

Parameter kueri

vstring | null
Versi katalog untuk caching (disertakan di ServiceRef.icon_url).

Parameter header

X-View-Asstring
Hanya untuk kunci API dengan peran admin. Menjalankan permintaan sebagai profil data <profile>[:viewer|verifier|editor], misalnya employee:viewer. Kunci instalasi tidak dapat memakai header ini (403).

Parameter cookie

kb_view_asstring
Cookie mode “View as” (Lihat sebagai) untuk sesi. POST /auth/view-as menetapkannya dan DELETE /auth/view-as menghapusnya.

Respons

200File ikon, atau 304 jika `If-None-Match` cocok.

Header respons

ETag
Sidik jari file logo. Kirim di If-None-Match untuk mendapatkan 304 jika logo tidak berubah.
Cache-Control
Aturan caching untuk respons.
RateLimit-Policy
Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.
RateLimit
Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).
X-RateLimit-Remaining
Sisa permintaan dalam batas paling ketat.
X-RateLimit-Reset
Detik hingga batas paling ketat direset.

image/webp

string (binary)

304Ikon tidak berubah (`If-None-Match` cocok dengan `ETag`).

Header respons

RateLimit-Policy
Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.
RateLimit
Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).
X-RateLimit-Remaining
Sisa permintaan dalam batas paling ketat.
X-RateLimit-Reset
Detik hingga batas paling ketat direset.

401Kredensial tidak dikirim (baik cookie sesi maupun kunci API), atau kunci tidak ditemukan.

Header respons

RateLimit-Policy
Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.
RateLimit
Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).
X-RateLimit-Remaining
Sisa permintaan dalam batas paling ketat.
X-RateLimit-Reset
Detik hingga batas paling ketat direset.

application/json

Objek: Error

403Tindakan tidak diizinkan: peran tidak memadai, tidak ada akses ke koleksi atau kartu, permintaan berjalan dalam mode “View as”, atau organisasi ditangguhkan atau dihapus (`detail` adalah objek dengan `code: org_suspended | org_deleted`).

Header respons

RateLimit-Policy
Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.
RateLimit
Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).
X-RateLimit-Remaining
Sisa permintaan dalam batas paling ketat.
X-RateLimit-Reset
Detik hingga batas paling ketat direset.

application/json

Objek: Error

404Objek tidak ada atau tidak tersedia bagi Anda. API tidak mengonfirmasi keberadaan objek yang dibatasi.

Header respons

RateLimit-Policy
Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.
RateLimit
Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).
X-RateLimit-Remaining
Sisa permintaan dalam batas paling ketat.
X-RateLimit-Reset
Detik hingga batas paling ketat direset.

application/json

Objek: Error

422Error validasi: isi atau parameter tidak sesuai dengan skema (`detail` berisi daftar error validasi), atau nilai parameter berada di luar rentang (`detail` berisi pesan).

Header respons

RateLimit-Policy
Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.
RateLimit
Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).
X-RateLimit-Remaining
Sisa permintaan dalam batas paling ketat.
X-RateLimit-Reset
Detik hingga batas paling ketat direset.

application/json

Objek: Error

429Terlalu banyak permintaan (`api.rate_limited`), kuota organisasi untuk menit, hari, atau bulan sudah habis (`api.quota_exceeded`; `error.details` berisi `quota`, `limit`, dan `reset_at`), batas organisasi tercapai, atau layanan jawaban sedang sibuk (`answers.engine_busy`). Tunggu selama waktu di header `Retry-After`.

Header respons

Retry-After
Jumlah detik yang perlu ditunggu sebelum Anda mencoba ulang permintaan.
RateLimit-Policy
Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.
RateLimit
Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).
X-RateLimit-Remaining
Sisa permintaan dalam batas paling ketat.
X-RateLimit-Reset
Detik hingga batas paling ketat direset.

application/json

Objek: Error

Kode error

Kode yang dapat dikembalikan endpoint ini di error.code, selain kode umum yang berlaku untuk setiap permintaan.

Batas laju

Respons berisi header RateLimit dan RateLimit-Policy serta header lama X-RateLimit-Limit, X-RateLimit-Remaining, dan X-RateLimit-Reset. Respons 429 berisi Retry-After dalam detik: tunggu, lalu coba lagi.

← catalog · Referensi API

curl 'https://api.sursa.com/v1/catalog/services/6f1d2c9e-7b0a-4c43-9a51-0d6c1c1f8e21/icon' \
  -o download.webp \
  -H "Authorization: Bearer $SURSA_API_KEY"

Coba

Kunci API

Kunci hanya disimpan di memori tab ini dan hanya dikirim ke https://api.sursa.com.

Permintaan bekerja pada data asli organisasi Anda.

X-View-As header

service_id path *

v query