Pāriet uz saturu
Sursa Developers

API rokasgrāmata

Publiskais Sursa API: 222 operācijas 35 sadaļās. Versija 1.62.0.

Publiskais Sursa API integrācijām, kas autentificējas ar API atslēgu. Izmaiņas /v1 ietvaros ir papildinošas: var parādīties jaunas operācijas, neobligāti parametri, atbildes lauki un jaunas uzskaitījumu vērtības atbildēs, un esošie klienti turpina darboties. Nezināmas uzskaitījumu vērtības atbildēs uzskatiet par derīgām.

Bāzes URL
https://api.sursa.com
Autentifikācija
Nosūtiet API atslēgu galvenē Authorization: Authorization: Bearer <atslēga>.

Sadaļas

health1 operācija

Pakalpojuma statuss un versija

auth1 operācija

Pierakstīšanās, sesijas, režīms „View as“ (skatīt kā), paroles maiņa un atiestatīšana, ielūgumu pieņemšana

users5 operācijas

Organizācijas lietotāju konti

api-keys9 operācijas

Organizācijas API atslēgas

apps8 operācijas

Organizācijas OAuth lietotnes un darbinieku autorizācijas

oauth3 operācijas

OAuth 2.0 protokols: piekrišanas ekrāns, marķieru izsniegšana un atsaukšana, autorizācijas servera metadati

audit4 operācijas

Organizācijas audita žurnāls

org1 operācija

Organizācija, tās logotips un datu eksports

categories4 operācijas

Dokumentu kategorijas

collections6 operācijas

Zināšanu kolekcijas

cards26 operācijas

Zināšanu kartītes: augšupielāde, saturs, tabulas, versijas, pārbaude, komentāri

jobs5 operācijas

Indeksēšanas rinda: darbi, nolasīšanas priekšskatījums, izmaiņu straume (SSE)

conversations2 operācijas

Sarunas ar asistentu

answers3 operācijas

Meklēšana un asistenta atbildes, arī SSE straume

access-requests4 operācijas

Pieprasījumi piekļūt slēptas atbildes avotiem

questions10 operāciju

Jautājumu žurnāls, ieteikumi, atbilžu eksports, dzīvā atbilde

files8 operācijas

Eksporta faili

insights1 operācija

Zināšanu analītika: kopsavilkums, dublikāti, robi zināšanās un zināšanu stāvoklis

tasks1 operācija

Lietotāja un komandas uzdevumi

sources19 operāciju

Datu avoti, piemēram, Google Drive un Confluence

permissions17 operāciju

Piekļuves modelis: atļauju reģistrs un atļaujas organizācijai, kolekcijām, kartītēm un avotiem – gan piešķirtas tieši, gan mantotas

roles4 operācijas

Lomas: nosaukti atļauju kopumi, iebūvēti un pielāgoti

groups7 operācijas

Lietotāju grupas: parastas grupas, „All members“ (visi dalībnieki), lomu grupas un personīgās grupas

folders7 operācijas

Kolekciju mapes: koks līdz trim līmeņiem, secība attiecībā pret blakus elementu, viena kartīte vairākās mapēs, mantotas atļaujas

catalog6 operācijas

Ārējo pakalpojumu (SaaS un piegādātāju) katalogs ar nosaukumiem, tīmekļa vietnēm, kategorijām, ikonām un aprakstiem, kā arī saites starp jūsu organizācijas lietotajiem nosaukumiem un kataloga ierakstiem

drafts6 operācijas

Melnraksti un publicēšanas apstiprināšana

verification9 operācijas

Pārbaude: statuss, termiņi, pārbaudītāji, vēsture, rinda „Verify first“ (pārbaudīt vispirms), uzticamības rādītājs (Trust Score) un atvienošana no organizācijas (offboarding)

announcements5 operācijas

Obligāti izlasāmi paziņojumi: auditorija, izlasīšanas apstiprinājums, pārskati, atgādinājumi, eksports

comments4 operācijas

Kartīšu komentāri pavedienos ar enkuru un statusu, kā arī reakcijas

webhooks17 operāciju

Organizācijas webhook paziņojumi: galapunkti, notikumu abonementi, paraksti, piegādes un atkārtojumi

public-api1 operācija

Publisks API integrācijām: šī API mašīnlasāmā specifikācija

uploads5 operācijas

Lielu failu augšupielāde pa daļām: sesija, daļas, pabeigšana ar pārbaudēm un izmantošana kartītei, arhīvam vai importam

analytics4 operācijas

Produkta analītika: lietošanas notikumi, skaitītāji pa objektiem, stāvokļa, lietošanas un ieguldījuma paneļi, līguma atjaunošanas pārskats un eksports

quality3 operācijas

Atbilžu kvalitāte: jautājumi bez labas atbildes un robi zināšanās, kuru risināšana ir sākta

finance6 operācijas

Finanšu dokumenti: valūtas kursi un darījuma partneru reģistrs

Objekti