Pereiti prie turinio
Sursa Developers

API žinynas

Viešoji Sursa API: 222 operacijos, 35 skyriai. Versija 1.62.0.

Viešoji Sursa API integracijoms, kurios tapatybę patvirtina API raktu. Pakeitimai /v1 ribose yra papildantys: gali atsirasti naujų operacijų, neprivalomų parametrų, atsako laukų ir atsako išvardijimų reikšmių, o esami klientai toliau veikia. Nežinomas atsako išvardijimų reikšmes laikykite galiojančiomis.

Bazinis URL
https://api.sursa.com
Autentifikavimas
Siųskite API raktą antraštėje Authorization: Authorization: Bearer <raktas>.

Skyriai

health1 operacija

Paslaugos būsena ir versija

auth1 operacija

Prisijungimas, sesijos, režimas „View as“ (žiūrėti kaip), slaptažodžio keitimas ir atkūrimas, kvietimų priėmimas

users5 operacijos

Organizacijos naudotojų paskyros

api-keys9 operacijos

Organizacijos API raktai

apps8 operacijos

Organizacijos OAuth programos ir darbuotojų autorizacijos

oauth3 operacijos

OAuth 2.0 protokolas: sutikimo langas, žetonų išdavimas ir atšaukimas, autorizacijos serverio metaduomenys

audit4 operacijos

Organizacijos audito žurnalas

org1 operacija

Organizacija, jos logotipas ir duomenų eksportas

categories4 operacijos

Dokumentų kategorijos

collections6 operacijos

Žinių rinkiniai

cards26 operacijos

Žinių kortelės: įkėlimas, turinys, lentelės, versijos, tikrinimas, komentarai

jobs5 operacijos

Indeksavimo eilė: darbai, nuskaitymo peržiūra, pakeitimų srautas (SSE)

conversations2 operacijos

Pokalbiai su asistentu

answers3 operacijos

Paieška ir asistento atsakymai, įskaitant SSE srautą

access-requests4 operacijos

Prašymai suteikti prieigą prie paslėpto atsakymo šaltinių

questions10 operacijų

Klausimų žurnalas, pasiūlymai, atsakymų eksportas, gyvas atsakymas

files8 operacijos

Eksporto failai

insights1 operacija

Žinių analitika: suvestinė, dublikatai, žinių spragos ir žinių būklė

tasks1 operacija

Naudotojo ir komandos užduotys

sources19 operacijų

Duomenų šaltiniai, pvz., Google Drive ir Confluence

permissions17 operacijų

Prieigos modelis: leidimų registras ir leidimai organizacijai, rinkiniams, kortelėms ir šaltiniams – tiek suteikti tiesiogiai, tiek paveldėti

roles4 operacijos

Vaidmenys: pavadinti leidimų deriniai, integruoti ir pasirinktiniai

groups7 operacijos

Naudotojų grupės: įprastos grupės, „All members“ (visi nariai), vaidmenų grupės ir asmeninės grupės

folders7 operacijos

Rinkinių aplankai: iki trijų lygių medis, tvarka gretimo elemento atžvilgiu, viena kortelė keliuose aplankuose, paveldėti leidimai

catalog6 operacijos

Išorinių paslaugų (SaaS ir tiekėjų) katalogas su pavadinimais, svetainėmis, kategorijomis, piktogramomis ir aprašymais, taip pat jūsų organizacijos vartojamų pavadinimų ir katalogo įrašų susiejimai

drafts6 operacijos

Juodraščiai ir paskelbimo patvirtinimas

verification9 operacijos

Tikrinimas: būsena, terminai, tikrintojai, istorija, eilė „Verify first“ (tikrinti pirmiausia), patikimumo balas ir pašalinimas iš organizacijos (offboarding)

announcements5 operacijos

Privalomi perskaityti pranešimai: auditorija, perskaitymo patvirtinimas, ataskaitos, priminimai, eksportas

comments4 operacijos

Kortelių komentarų gijos su inkaru ir būsena, taip pat reakcijos

webhooks17 operacijų

Organizacijos webhook pranešimai: galiniai taškai, įvykių prenumeratos, parašai, pristatymai ir pakartojimai

public-api1 operacija

Viešoji API integracijoms: šios API specifikacija mašinai skaitomu formatu

uploads5 operacijos

Didelių failų įkėlimas dalimis: sesija, dalys, užbaigimas su patikromis ir panaudojimas kortelėje, archyve ar importe

analytics4 operacijos

Produkto analitika: naudojimo įvykiai, objektų skaitikliai, būklės, naudojimo ir indėlio skydeliai, sutarties atnaujinimo ataskaita ir eksportas

quality3 operacijos

Atsakymų kokybė: klausimai be gero atsakymo ir žinių spragos, kurias pradėta spręsti

finance6 operacijos

Finansiniai dokumentai: valiutų kursai ir kontrahentų registras

Objektai