Pular para o conteúdo
Sursa Developers

Referência da API

A API pública do Sursa: 222 endpoints em 35 seções. Versão 1.62.0.

A API pública do Sursa para integrações que se autenticam com uma chave de API. As alterações dentro de /v1 são aditivas: podem surgir novas operações, parâmetros opcionais, campos de resposta e valores de enumeração nas respostas, e os clientes existentes continuam funcionando. Trate valores de enumeração desconhecidos nas respostas como válidos.

URL base
https://api.sursa.com
Autenticação
Envie uma chave de API no cabeçalho Authorization: Authorization: Bearer <chave>.

Seções

health1 endpoint

Status e versão do serviço

auth1 endpoint

Login, sessões, modo “View as” (ver a base como um perfil de dados a vê), alteração e redefinição de senha, aceitação de convites

users5 endpoints

Contas de usuário da organização

api-keys9 endpoints

Chaves de API da organização

apps8 endpoints

Apps OAuth da organização e autorizações de colaboradores

oauth3 endpoints

O protocolo OAuth 2.0: tela de consentimento, emissão e revogação de tokens, metadados do servidor de autorização

audit4 endpoints

Registro de auditoria da organização

org1 endpoint

A organização, o logotipo dela e a exportação de dados

categories4 endpoints

Categorias de documentos

collections6 endpoints

Coleções de conhecimento

cards26 endpoints

Cartões de conhecimento: upload, conteúdo, tabelas, versões, verificação, comentários

jobs5 endpoints

Fila de indexação: jobs, prévia da análise, stream de alterações (SSE)

conversations2 endpoints

Conversas com o assistente

answers3 endpoints

Busca e respostas do assistente, incluindo o stream SSE

access-requests4 endpoints

Solicitações de acesso às fontes de uma resposta oculta

questions10 endpoints

Registro de perguntas, sugestões, exportações de respostas, resposta dinâmica

files8 endpoints

Arquivos de exportação

insights1 endpoint

Análise do conhecimento: resumo, duplicatas, lacunas de conhecimento e saúde do conhecimento

tasks1 endpoint

Tarefas de um usuário e de uma equipe

sources19 endpoints

Fontes de dados, como Google Drive e Confluence

permissions17 endpoints

Modelo de acesso: o registro de permissões e as permissões sobre a organização, as coleções, os cartões e as fontes, tanto as concedidas diretamente quanto as herdadas

roles4 endpoints

Funções: conjuntos nomeados de permissões, internas e personalizadas

groups7 endpoints

Grupos de usuários: grupos comuns, “All members” (todos os membros), grupos de função e grupos pessoais

folders7 endpoints

Pastas das coleções: uma árvore de até três níveis, ordem relativa a um elemento irmão, um cartão em várias pastas, permissões herdadas

catalog6 endpoints

Catálogo de serviços externos (SaaS e fornecedores) com nomes, sites, categorias, ícones e descrições, e vínculos entre os nomes usados na sua organização e os itens do catálogo

drafts6 endpoints

Rascunhos e aprovação da publicação

verification9 endpoints

Verificação: status, datas de vencimento, verificadores, histórico, a fila “Verify first” (verificar primeiro), “Trust Score” (índice de confiança) e desligamento

announcements5 endpoints

Comunicados de leitura obrigatória: público, confirmação de leitura, relatórios, lembretes, exportação

comments4 endpoints

Comentários em threads nos cartões, com âncora e status, e reações

webhooks17 endpoints

Webhooks da organização: cadastro dos webhooks, inscrições em eventos, assinaturas, entregas e novas tentativas

public-api1 endpoint

API pública para integrações: a especificação desta API em formato legível por máquina

uploads5 endpoints

Uploads em partes de arquivos grandes: a sessão, as partes, a conclusão com conferências e o uso por um cartão, um arquivo compactado ou uma importação

analytics4 endpoints

Análises do produto: eventos de uso, contadores por objeto, os painéis de saúde, de uso e de contribuição, o relatório de renovação e as exportações

quality3 endpoints

Qualidade das respostas: perguntas sem uma boa resposta e as lacunas de conhecimento colocadas em andamento

finance6 endpoints

Documentos financeiros: taxas de câmbio e o cadastro de contrapartes

Objetos