Hopp til innholdet
Sursa Developers

API-referanse

Sursas offentlige API: 222 operasjoner i 35 seksjoner. Versjon 1.62.0.

Sursas offentlige API for integrasjoner som autentiserer seg med en API-nøkkel. Endringer innenfor /v1 er tilleggsendringer: nye operasjoner, valgfrie parametere, felt i svar og enum-verdier i svar kan komme til, og eksisterende klienter fortsetter å fungere. Behandle ukjente enum-verdier i svar som gyldige.

Basis-URL
https://api.sursa.com
Autentisering
Send en API-nøkkel i headeren Authorization: Authorization: Bearer <nøkkel>.

Seksjoner

health1 operasjon

Tjenestestatus og versjon

auth1 operasjon

Pålogging, økter, modusen «View as» (vis som), endring og tilbakestilling av passord, godtakelse av invitasjoner

users5 operasjoner

Brukerkontoer i organisasjonen

api-keys9 operasjoner

Organisasjonens API-nøkler

apps8 operasjoner

Organisasjonens OAuth-apper og autorisasjoner for ansatte

oauth3 operasjoner

OAuth 2.0-protokollen: samtykkeskjerm, utstedelse og tilbaketrekking av tokener, metadata for autorisasjonsserveren

audit4 operasjoner

Organisasjonens revisjonslogg

org1 operasjon

Organisasjonen, logoen dens og dataeksport

categories4 operasjoner

Dokumentkategorier

collections6 operasjoner

Kunnskapssamlinger

cards26 operasjoner

Kunnskapskort: opplasting, innhold, tabeller, versjoner, verifisering, kommentarer

jobs5 operasjoner

Indekseringskø: jobber, forhåndsvisning av tolkingen, endringsstrøm (SSE)

conversations2 operasjoner

Samtaler med assistenten

answers3 operasjoner

Søk og svar fra assistenten, inkludert SSE-strømmen

access-requests4 operasjoner

Tilgangsforespørsler til kildene for et skjult svar

questions10 operasjoner

Spørsmålslogg, forslag, eksport av svar, live-svar

files8 operasjoner

Eksportfiler

insights1 operasjon

Kunnskapsinnsikt: sammendrag, duplikater, kunnskapshull og kunnskapsbasens helse

tasks1 operasjon

Oppgavene til en bruker og et team

sources19 operasjoner

Datakilder, for eksempel Google Drive og Confluence

permissions17 operasjoner

Tilgangsmodell: registeret over tillatelser og tillatelser på organisasjonen, samlinger, kort og kilder, både tildelt direkte og arvet

roles4 operasjoner

Roller: navngitte sett med tillatelser, innebygde og egendefinerte

groups7 operasjoner

Brukergrupper: vanlige grupper, «All members» (alle medlemmer), rollegrupper og personlige grupper

folders7 operasjoner

Mapper i samlinger: et tre med opptil tre nivåer, rekkefølge i forhold til et naboelement, ett kort i flere mapper, arvede tillatelser

catalog6 operasjoner

Katalog over eksterne tjenester (SaaS og leverandører) med navn, nettsteder, kategorier, ikoner og beskrivelser, og tilknytninger mellom navnene i organisasjonen din og katalogoppføringer

drafts6 operasjoner

Utkast og godkjenning av publisering

verification9 operasjoner

Verifisering: status, frister, kontrollører, historikk, køen «Verify first» (verifiser først), Trust Score (tillitsscore) og offboarding

announcements5 operasjoner

Kunngjøringer med pliktlesning: målgruppe, lesebekreftelse, rapporter, påminnelser, eksport

comments4 operasjoner

Kommentartråder på kort med anker og status, og reaksjoner

webhooks17 operasjoner

Organisasjonens webhooks: endepunkter, abonnementer på hendelser, signaturer, leveranser og nye forsøk

public-api1 operasjon

Offentlig API for integrasjoner: den maskinlesbare spesifikasjonen av dette API-et

uploads5 operasjoner

Flerdelt opplasting av store filer: økten, delene, fullføring med kontroller og bruk i et kort, et arkiv eller en import

analytics4 operasjoner

Produktanalyse: brukshendelser, tellere per objekt, dashbordene for helse, bruk og bidrag, fornyelsesrapporten og eksporter

quality3 operasjoner

Svarkvalitet: spørsmål uten et godt svar og kunnskapshull som er tatt til behandling

finance6 operasjoner

Økonomiske dokumenter: valutakurser og registeret over motparter

Objekter