Hoppa till innehållet
Sursa Developers

API-referens

Sursas offentliga API: 222 slutpunkter i 35 avsnitt. Version 1.62.0.

Sursas offentliga API för integrationer som autentiserar sig med en API-nyckel. Ändringar inom /v1 är tilläggsändringar: nya åtgärder, valfria parametrar, fält i svar och uppräkningsvärden i svar kan tillkomma, och befintliga klienter fortsätter att fungera. Behandla okända uppräkningsvärden i svar som giltiga.

Bas-URL
https://api.sursa.com
Autentisering
Skicka en API-nyckel i huvudet Authorization: Authorization: Bearer <nyckel>.

Avsnitt

health1 slutpunkt

Tjänstens status och version

auth1 slutpunkt

Inloggning, sessioner, läget ”View as” (visa som en annan användare), ändring och återställning av lösenord, accepterande av inbjudningar

users5 slutpunkter

Organisationens användarkonton

api-keys9 slutpunkter

Organisationens API-nycklar

apps8 slutpunkter

Organisationens OAuth-appar och medarbetares auktoriseringar

oauth3 slutpunkter

Protokollet OAuth 2.0: samtyckesskärm, utfärdande och återkallelse av token, metadata för auktoriseringsservern

audit4 slutpunkter

Organisationens granskningslogg

org1 slutpunkt

Organisationen, dess logotyp och dataexport

categories4 slutpunkter

Dokumentkategorier

collections6 slutpunkter

Kunskapssamlingar

cards26 slutpunkter

Kunskapskort: uppladdning, innehåll, tabeller, versioner, verifiering, kommentarer

jobs5 slutpunkter

Indexeringskö: jobb, förhandsvisning av tolkningen, ändringsström (SSE)

conversations2 slutpunkter

Konversationer med assistenten

answers3 slutpunkter

Sökning och assistentens svar, inklusive SSE-strömmen

access-requests4 slutpunkter

Åtkomstbegäranden till källorna bakom ett dolt svar

questions10 slutpunkter

Frågelogg, förslag, export av svar, live-svar

files8 slutpunkter

Exportfiler

insights1 slutpunkt

Kunskapsinsikter: sammanfattning, dubbletter, kunskapsluckor och kunskapens hälsa

tasks1 slutpunkt

Uppgifter för en användare och för ett team

sources19 slutpunkter

Datakällor, till exempel Google Drive och Confluence

permissions17 slutpunkter

Åtkomstmodell: behörighetsregistret och behörigheter för organisationen, samlingar, kort och källor, både direkt tilldelade och ärvda

roles4 slutpunkter

Roller: namngivna uppsättningar behörigheter, inbyggda och anpassade

groups7 slutpunkter

Användargrupper: vanliga grupper, ”All members” (alla medlemmar), rollgrupper och personliga grupper

folders7 slutpunkter

Mappar i samlingar: ett träd med upp till tre nivåer, ordning i förhållande till ett element på samma nivå, ett kort i flera mappar, ärvda behörigheter

catalog6 slutpunkter

Katalog över externa tjänster (SaaS och leverantörer) med namn, webbplatser, kategorier, ikoner och beskrivningar samt kopplingar mellan din organisations namn och katalogposter

drafts6 slutpunkter

Utkast och godkännande för publicering

verification9 slutpunkter

Verifiering: status, förfallodatum, granskare, historik, kön ”Verify first” (verifiera först), ”Trust Score” (förtroendepoäng) och offboarding

announcements5 slutpunkter

Meddelanden med obligatorisk läsning: målgrupp, läsbekräftelse, rapporter, påminnelser, export

comments4 slutpunkter

Kommentarstrådar på kort med förankring och status samt reaktioner

webhooks17 slutpunkter

Organisationens webhookar: själva webhookarna, prenumerationer på händelser, signaturer, leveranser och nya försök

public-api1 slutpunkt

Offentligt API för integrationer: den maskinläsbara specifikationen för detta API

uploads5 slutpunkter

Uppladdning av stora filer i delar (multipart): sessionen, delarna, slutförande med kontroller och användning i ett kort, ett arkiv eller en import

analytics4 slutpunkter

Produktanalys: användningshändelser, räknare per objekt, panelerna för hälsa, användning och bidrag, förnyelserapporten och exporter

quality3 slutpunkter

Svarskvalitet: frågor utan ett bra svar och kunskapsluckor som har börjat åtgärdas

finance6 slutpunkter

Finansiella dokument: växelkurser och motpartsregistret

Objekt