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

Hent ikonet til en tjeneste

get_catalog_service_icon

Returnerer tjenestens ikon: en WebP på 128×128 med gjennomsiktig bakgrunn som følger med Sursa. Svaret endres aldri: Cache-Control: public, max-age=31536000, immutable, og ETag kombinerer katalogversjonen og ID-en (send den i If-None-Match for å få 304). Parameteren v (katalogversjonen, som allerede inngår i icon_url) skiller versjonene i nettleserens hurtigbuffer. For en oppføring uten ikon (icon: false) returnerer operasjonen 404 catalog.icon_not_found, og grensesnittet viser initialer. Hvis installasjonen leverer ikoner fra en ekstern adresse, peker icon_url dit, og denne operasjonen er fortsatt tilgjengelig.

Autentisering

Send en API-nøkkel i headeren Authorization: Authorization: Bearer <nøkkel>.

Baneparametere

service_idstring (uuid)obligatorisk
ID for oppføringen i tjenestekatalogen (UUID).

Spørringsparametere

vstring | null
Katalogversjon for hurtigbufring (inngår i ServiceRef.icon_url).

Headerparametere

X-View-Asstring
Bare for API-nøkler med rollen admin. Utfører forespørselen som dataprofilen <profile>[:viewer|verifier|editor], for eksempel employee:viewer. Installasjonsnøkkelen kan ikke bruke denne headeren (403).

Parametere i informasjonskapsler

kb_view_asstring
Informasjonskapsel for modusen «View as» (vis som) i en økt. POST /auth/view-as setter den, og DELETE /auth/view-as fjerner den.

Svar

200Ikonfilen, eller 304 hvis `If-None-Match` stemmer.

Headere i svaret

ETag
Fingeravtrykk av logofilen. Send det i If-None-Match for å få 304 når logoen ikke er endret.
Cache-Control
Regler for hurtigbufring av svaret.
RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

image/webp

string (binary)

304Ikonet er ikke endret (`If-None-Match` stemmer med `ETag`).

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

401Ingen påloggingsinformasjon ble sendt (verken øktinformasjonskapsel eller API-nøkkel), eller nøkkelen ble ikke funnet.

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

403Handlingen er ikke tillatt: rollen er utilstrekkelig, det finnes ingen tilgang til samlingen eller kortet, forespørselen kjører i modusen «View as», eller organisasjonen er suspendert eller slettet (`detail` er et objekt med `code: org_suspended | org_deleted`).

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

404Objektet finnes ikke eller er ikke tilgjengelig for deg. API-et bekrefter ikke at et objekt med begrenset tilgang finnes.

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

422Valideringsfeil: brødteksten eller parameterne samsvarer ikke med skjemaet (`detail` er en liste over valideringsfeil), eller en parameterverdi er utenfor tillatt område (`detail` er en melding).

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

429For mange forespørsler (`api.rate_limited`), organisasjonens kvote for minuttet, døgnet eller måneden er brukt opp (`api.quota_exceeded`; `error.details` inneholder `quota`, `limit` og `reset_at`), organisasjonens grense er nådd, eller svartjenesten er opptatt (`answers.engine_busy`). Vent så lenge som headeren `Retry-After` angir.

Headere i svaret

Retry-After
Antall sekunder du skal vente før du prøver forespørselen på nytt.
RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

Feilkoder

Kodene denne operasjonen kan returnere i error.code, i tillegg til de generelle kodene for alle forespørsler.

Hastighetsgrenser

Svarene har headerne RateLimit og RateLimit-Policy og de eldre X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Et 429-svar har Retry-After i sekunder: Vent, og prøv på nytt.

← catalog · API-referanse

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

Prøv

API-nøkkel

Nøkkelen lagres bare i minnet til denne fanen og sendes bare til https://api.sursa.com.

Forespørslene utføres på de faktiske dataene i organisasjonen din.

X-View-As header

service_id path *

v query