Siirry sisältöön
Sursa Developers

API-viite

Sursan julkinen API: 222 päätepistettä 35 osiossa. Versio 1.62.0.

Sursan julkinen API integraatioille, jotka todennetaan API-avaimella. Muutokset /v1-version sisällä ovat lisääviä: uusia toimintoja, valinnaisia parametreja, vastauskenttiä ja vastausten enum-arvoja voi tulla lisää, ja nykyiset asiakasohjelmat toimivat edelleen. Käsittele vastausten tuntemattomia enum-arvoja kelvollisina.

Perus-URL
https://api.sursa.com
Todennus
Lähetä API-avain Authorization-otsakkeessa: Authorization: Bearer <avain>.

Osiot

health1 päätepiste

Palvelun tila ja versio

auth1 päätepiste

Kirjautuminen, istunnot, ”View as” -tila (näkymä toisen käyttäjän silmin), salasanan vaihto ja palautus, kutsujen hyväksyminen

users5 päätepistettä

Organisaation käyttäjätilit

api-keys9 päätepistettä

Organisaation API-avaimet

apps8 päätepistettä

Organisaation OAuth-sovellukset ja työntekijöiden valtuutukset

oauth3 päätepistettä

OAuth 2.0 -protokolla: suostumusnäkymä, tunnusten myöntäminen ja peruutus, valtuutuspalvelimen metatiedot

audit4 päätepistettä

Organisaation tarkastusloki

org1 päätepiste

Organisaatio, sen logo ja tietojen vienti

categories4 päätepistettä

Asiakirjaluokat

collections6 päätepistettä

Tietokokoelmat

cards26 päätepistettä

Tietokortit: lataus, sisältö, taulukot, versiot, vahvistus, kommentit

jobs5 päätepistettä

Indeksointijono: työt, jäsennyksen esikatselu, muutosvirta (SSE)

conversations2 päätepistettä

Keskustelut avustajan kanssa

answers3 päätepistettä

Haku ja avustajan vastaukset, myös SSE-virta

access-requests4 päätepistettä

Käyttöoikeuspyynnöt piilotetun vastauksen lähteisiin

questions10 päätepistettä

Kysymysloki, ehdotukset, vastausten viennit, päivittyvä vastaus

files8 päätepistettä

Vientitiedostot

insights1 päätepiste

Tietoanalytiikka: yhteenveto, kaksoiskappaleet, tietoaukot ja tiedon kunto

tasks1 päätepiste

Käyttäjän ja tiimin tehtävät

sources19 päätepistettä

Tietolähteet, kuten Google Drive ja Confluence

permissions17 päätepistettä

Käyttöoikeusmalli: käyttöoikeusrekisteri ja käyttöoikeudet organisaatioon, kokoelmiin, kortteihin ja lähteisiin, niin suoraan myönnetyt kuin perityt

roles4 päätepistettä

Roolit: nimetyt käyttöoikeuksien joukot, sisäänrakennetut ja mukautetut

groups7 päätepistettä

Käyttäjäryhmät: tavalliset ryhmät, ”All members” (kaikki jäsenet), rooliryhmät ja henkilökohtaiset ryhmät

folders7 päätepistettä

Kokoelmien kansiot: enintään kolmitasoinen puu, järjestys suhteessa sisarkohteeseen, yksi kortti useassa kansiossa, perityt käyttöoikeudet

catalog6 päätepistettä

Ulkoisten palvelujen (SaaS-palvelut ja toimittajat) luettelo, jossa on nimet, verkkosivustot, luokat, kuvakkeet ja kuvaukset, sekä organisaatiosi nimien ja luettelomerkintöjen väliset linkit

drafts6 päätepistettä

Luonnokset ja julkaisun hyväksyntä

verification9 päätepistettä

Vahvistus: tila, eräpäivät, vahvistajat, historia, ”Verify first” -jono (ensin vahvistettavat kortit), Trust Score (luotettavuusaste) ja lähtöprosessi

announcements5 päätepistettä

Pakolliset luettavat tiedotteet: kohdeyleisö, lukukuittaus, raportit, muistutukset, vienti

comments4 päätepistettä

Ketjutetut korttikommentit, joilla on kiinnityskohta ja tila, sekä reaktiot

webhooks17 päätepistettä

Organisaation webhookit ja niiden tapahtumatilaukset, allekirjoitukset, toimitukset ja uusintayritykset

public-api1 päätepiste

Julkinen API integraatioille: tämän API:n koneluettava määrittely

uploads5 päätepistettä

Suurten tiedostojen moniosaiset lataukset: istunto, osat, viimeistely tarkistuksineen sekä käyttö kortissa, arkistossa tai tuonnissa

analytics4 päätepistettä

Tuoteanalytiikka: käyttötapahtumat, objektikohtaiset laskurit, kunnon, käytön ja osallistumisen koontinäkymät, uusimisraportti ja viennit

quality3 päätepistettä

Vastausten laatu: kysymykset, joihin ei ole hyvää vastausta, ja työn alle otetut tietoaukot

finance6 päätepistettä

Taloudelliset asiakirjat: valuuttakurssit ja vastapuolirekisteri

Objektit