Direct naar de inhoud
Sursa Developers

API-referentie

De openbare API van Sursa: 222 endpoints in 35 secties. Versie 1.62.0.

De openbare API van Sursa voor integraties die zich authenticeren met een API-sleutel. Wijzigingen binnen /v1 zijn aanvullend: er kunnen nieuwe bewerkingen, optionele parameters, responsevelden en enumwaarden in responses bij komen, en bestaande clients blijven werken. Behandel onbekende enumwaarden in responses als geldig.

Basis-URL
https://api.sursa.com
Authenticatie
Stuur een API-sleutel mee in de header Authorization: Authorization: Bearer <sleutel>.

Secties

health1 endpoint

Servicestatus en versie

auth1 endpoint

Aanmelding, sessies, modus “View as” (bekijken als een andere gebruiker), wachtwoord wijzigen en herstellen, uitnodigingen accepteren

users5 endpoints

Gebruikersaccounts van de organisatie

api-keys9 endpoints

API-sleutels van de organisatie

apps8 endpoints

OAuth-apps van de organisatie en autorisaties van medewerkers

oauth3 endpoints

Het OAuth 2.0-protocol: toestemmingsscherm, uitgifte en intrekking van tokens, metadata van de autorisatieserver

audit4 endpoints

Auditlog van de organisatie

org1 endpoint

De organisatie, haar logo en de export van haar gegevens

categories4 endpoints

Documentcategorieën

collections6 endpoints

Kenniscollecties

cards26 endpoints

Kenniskaarten: upload, inhoud, tabellen, versies, verificatie, opmerkingen

jobs5 endpoints

Indexeringswachtrij: jobs, voorbeeld van het parseren, wijzigingsstream (SSE)

conversations2 endpoints

Gesprekken met de assistent

answers3 endpoints

Zoeken en antwoorden van de assistent, inclusief de SSE-stream

access-requests4 endpoints

Verzoeken om toegang tot de bronnen van een verborgen antwoord

questions10 endpoints

Vragenlog, suggesties, exports van antwoorden, live antwoord

files8 endpoints

Exportbestanden

insights1 endpoint

Kennisinzichten: samenvatting, duplicaten, kennishiaten en gezondheid van de kennis

tasks1 endpoint

Taken van een gebruiker en van een team

sources19 endpoints

Gegevensbronnen, zoals Google Drive en Confluence

permissions17 endpoints

Toegangsmodel: het rechtenregister en rechten op de organisatie, collecties, kaarten en bronnen, zowel direct toegekend als overgenomen

roles4 endpoints

Rollen: benoemde sets rechten, ingebouwd en aangepast

groups7 endpoints

Gebruikersgroepen: gewone groepen, “All members” (alle leden), rolgroepen en persoonlijke groepen

folders7 endpoints

Mappen van collecties: een boom tot drie niveaus diep, volgorde ten opzichte van een element op hetzelfde niveau, één kaart in meerdere mappen, overgenomen rechten

catalog6 endpoints

Catalogus van externe diensten (SaaS en leveranciers) met namen, websites, categorieën, pictogrammen en beschrijvingen, en koppelingen tussen de namen in je organisatie en catalogusitems

drafts6 endpoints

Concepten en goedkeuring voor publicatie

verification9 endpoints

Verificatie: status, vervaldatums, controleurs, geschiedenis, de wachtrij “Verify first” (eerst verifiëren), “Trust Score” (betrouwbaarheidsscore) en offboarding

announcements5 endpoints

Aankondigingen met verplichte lectuur: doelgroep, leesbevestiging, rapporten, herinneringen, export

comments4 endpoints

Opmerkingen bij kaarten in threads, met een anker en een status, en emoji-reacties

webhooks17 endpoints

Webhooks van de organisatie: de webhooks zelf, abonnementen op events, handtekeningen, leveringen en nieuwe pogingen

public-api1 endpoint

Openbare API voor integraties: de machineleesbare specificatie van deze API

uploads5 endpoints

Uploads in delen van grote bestanden: de sessie, de delen, afronding met controles en gebruik door een kaart, een archief of een import

analytics4 endpoints

Productanalyses: gebruiksevents, tellers per object, de dashboards voor gezondheid, gebruik en bijdragen, het verlengingsrapport en exports

quality3 endpoints

Kwaliteit van de antwoorden: vragen zonder goed antwoord en de kennishiaten die in behandeling zijn genomen

finance6 endpoints

Financiële documenten: wisselkoersen en het relatiebestand

Objecten