API başvurusu
Herkese açık Sursa API: 35 bölümde 222 uç nokta. Sürüm 1.62.0.
API anahtarıyla kimlik doğrulayan entegrasyonlar için Sursa’nın herkese açık API’si. /v1 içindeki değişiklikler ekleme niteliğindedir: yeni işlemler, isteğe bağlı parametreler, yanıt alanları ve yanıtlarda yeni enum değerleri eklenebilir; mevcut istemciler çalışmaya devam eder. Yanıtlardaki bilinmeyen enum değerlerini geçerli sayın.
- Temel URL
- https://api.sursa.com
- Kimlik doğrulama
- API anahtarını Authorization başlığında gönderin: Authorization: Bearer <anahtar>.
Bölümler
Hizmet durumu ve sürümü
Oturum açma, oturumlar, “View as” modu, parola değiştirme ve sıfırlama, davetleri kabul etme
Kuruluşun kullanıcı hesapları
Kuruluşun API anahtarları
Kuruluşun OAuth uygulamaları ve çalışan yetkilendirmeleri
OAuth 2.0 protokolü: onay ekranı, belirteç verme ve iptal etme, yetkilendirme sunucusu meta verileri
Kuruluşun denetim kaydı
Kuruluş, logosu ve veri dışa aktarma
Belge kategorileri
Bilgi koleksiyonları
Bilgi kartları: yükleme, içerik, tablolar, sürümler, doğrulama, yorumlar
Dizinleme kuyruğu: işler, ayrıştırma önizlemesi, değişiklik akışı (SSE)
Asistanla sohbetler
Arama ve asistanın yanıtları, SSE akışı dahil
Gizlenen bir yanıtın kaynaklarına erişim talepleri
Soru kaydı, öneriler, yanıt dışa aktarmaları, canlı yanıt
Dışa aktarma dosyaları
Bilgi analizleri: özet, yinelenen kartlar, bilgi boşlukları ve bilgi sağlığı
Kullanıcının ve ekibin görevleri
Google Drive ve Confluence gibi veri kaynakları
Erişim modeli: izin listesi ve kuruluş, koleksiyonlar, kartlar ve kaynaklar üzerindeki doğrudan verilen ve devralınan izinler
Roller: yerleşik ve özel, adlandırılmış izin kümeleri
Kullanıcı grupları: normal gruplar, “All members” (tüm üyeler), rol grupları ve kişisel gruplar
Koleksiyon klasörleri: en fazla üç seviye derinliğinde bir ağaç, kardeş öğeye göre sıralama, bir kartın birden çok klasörde yer alması, devralınan izinler
Adları, web siteleri, kategorileri, simgeleri ve açıklamalarıyla harici hizmetler (SaaS ve tedarikçiler) kataloğu ve kuruluşunuzdaki adlarla katalog kayıtları arasındaki bağlantılar
Taslaklar ve yayın onayı
Doğrulama: durum, son tarihler, doğrulayıcılar, geçmiş, “Verify first” kuyruğu (önce doğrulanacak kartlar), Trust Score (güven puanı) ve işten ayrılış
Zorunlu okuma duyuruları: hedef kitle, okundu onayı, raporlar, hatırlatmalar, dışa aktarma
Bağlandığı metin parçası ve durumu olan yorum dizileri hâlinde kart yorumları ve tepkiler
Kuruluşun webhook’ları: webhook nesneleri, olay abonelikleri, imzalar, teslimler ve yeniden denemeler
Entegrasyonlar için herkese açık API: bu API’nin makine tarafından okunabilir spesifikasyonu
Büyük dosyaların çok parçalı yüklemeleri: oturum, parçalar, denetimlerle tamamlama ve bir kartta, arşivde ya da içe aktarmada kullanım
Ürün analitiği: kullanım olayları, nesne başına sayaçlar, sağlık, kullanım ve katkı panelleri, yenileme raporu ve dışa aktarmalar
Yanıt kalitesi: iyi bir yanıtı olmayan sorular ve üzerinde çalışmaya alınan bilgi boşlukları
Finansal belgeler: döviz kurları ve karşı taraf rehberi
Nesneler
- AccessRequest
- AccessRequestDeny
- AccessRequestGrant
- AccessRequestList
- AccessRequestSource
- AccessRequestUser
- AccessRole
- AccessRoleCreate
- AccessRoleKind
- AccessRoleList
- AccessRoleScope
- AccessRoleUpdate
- Acl
- ActivityItem
- AnalyticsCardStats
- AnalyticsContribution
- AnalyticsHealth
- AnalyticsPeriod
- AnalyticsUsage
- Announcement
- AnnouncementAudience
- AnnouncementCreate
- AnnouncementList
- AnnouncementRecipient
- AnnouncementStats
- AnnouncementStatsSummary
- AnnouncementUsage
- AnswerAltPeriod
- AnswerAssignment
- AnswerBasis
- AnswerBasisCollection
- AnswerBasisCounted
- AnswerBasisExcluded
- AnswerBasisFlagged
- AnswerBasisScope
- AnswerCacheHit
- AnswerDataKind
- AnswerDrilldown
- AnswerEntity
- AnswerOutOfScope
- AnswerPeriod
- AnswerResponse
- AnswerSourceKind
- AnswerVerification
- AnswerVerificationItem
- AnswerWarning
- ApiKeyCreate
- ApiKeyCreated
- ApiKeyRoll
- ApiKeyRolled
- ApiKeyRow
- ApiKeyScope
- ApiKeyUpdate
- ApiLogEntry
- ApiLogList
- ApiUsage
- ApiUsagePoint
- ArchiveDocument
- ArchiveInfo
- ArchiveJob
- ArchiveSkip
- ArchiveSource
- ArchiveUploadForm
- ArchiveUploadFromUpload
- ArchiveUploadResult
- AskRequest
- Attachment
- AttachmentKind
- AuditActionCount
- AuditChainReport
- AuditEntry
- AuditExportRow
- BulkAction
- BulkRequest
- BulkResult
- BulkSkipped
- BulkSkipReason
- Calculation
- CalculationInput
- CallerApp
- CallerDataProfile
- CallerIdentity
- CallerKey
- CallerOrg
- CallerRateLimit
- CallerUser
- Card
- CardBrief
- CardBriefRow
- CardComment
- CardContent
- CardContentFile
- CardContentText
- CardCount
- CardDeleteResult
- CardEnrichmentStatus
- CardEvent
- CardExpanded
- CardExportFile
- CardFile
- CardFileUpsertForm
- CardFolderRef
- CardKind
- CardList
- CardPart
- CardSort
- CardStats
- CardStatsDay
- CardsXlsx
- CardTable
- CardTextContentType
- CardTextUpsert
- CardUpdate
- CardUploadForm
- CardUploadFromUpload
- CardUsage
- CardUsageEvent
- CardUsageItem
- CardUsageRow
- CardVerification
- CardVersion
- CardVersionDiff
- CatalogCategory
- CatalogResolveMatch
- CatalogResolveRequest
- CatalogResolveResponse
- CatalogService
- CategoryCount
- CategoryCreate
- CategoryDeleteResult
- CategoryProgress
- CategoryRef
- CategorySource
- CategoryUpdate
- CellType
- ChartReason
- ChartSpec
- ChartType
- ChatDone
- ChatErrorCode
- ChatEvent
- ChatEventData
- ChatEventError
- ChatEventFollowups
- ChatEventInterrupt
- ChatEventMeta
- ChatEventSources
- ChatEventStage
- ChatEventToken
- ChatEventTool
- ChatMessage
- ChatRequest
- ChatScope
- ChatScopePeriod
- ChatStage
- ChatStageInfo
- Collection
- CollectionDeleteResult
- CollectionExpanded
- CollectionHealth
- CollectionList
- CollectionRef
- CollectionReindex
- CollectionReindexResult
- CollectionRequest
- CollectionStats
- CollectionUpdate
- ColumnMeta
- ColumnRole
- CommentCreate
- CommentRequest
- CommentStatus
- CommentWithMentions
- ConfluenceSource
- ConnectorSource
- ContentJSON
- ContributionDay
- Contributor
- ConversationDetail
- ConversationList
- ConversationPublic
- DataProfileBrief
- Dataset
- DatasetCell
- DatasetColumn
- DatasetGroup
- DatasetRole
- DataSource
- DeletedResponse
- Delivery
- DiffHunk
- DiffLine
- DiffRow
- DocInvoiceExtraction
- DocInvoiceFields
- DocInvoiceLine
- DocInvoiceParty
- DocInvoiceTax
- DocKind
- DocumentCategory
- DocumentCategoryList
- DownloadFile
- Draft
- DraftCollaborator
- DraftCreate
- DraftList
- DraftScope
- DraftUpdate
- DraftWorkflowState
- DriveSource
- EditingLock
- EngineHealth
- EngineHealthLimited
- EngineLicenseSummary
- EntityAction
- EntityKind
- Error
- ErrorDetailObject
- ErrorInfo
- EventAccessRequest
- EventAccessRequestCreated
- EventAccessRequestResolved
- EventAnnouncement
- EventAnnouncementRead
- EventAnnouncementSent
- EventAPIKey
- EventApiKeyCreated
- EventApiKeyExpiring
- EventApiKeyRevoked
- EventAppAuthorized
- EventAppRevoked
- EventCard
- EventCardArchived
- EventCardCreated
- EventCardDeleted
- EventCardIndexed
- EventCardIndexFailed
- EventCardMoved
- EventCardPublished
- EventCardRestored
- EventCardUnverified
- EventCardUpdated
- EventCardVerified
- EventCollection
- EventCollectionCreated
- EventCollectionDeleted
- EventCollectionUpdated
- EventComment
- EventCommentCreated
- EventCommentResolved
- EventCreditsLow
- EventDraft
- EventDraftApproved
- EventDraftCreated
- EventDraftPublishRequested
- EventExportReady
- EventFile
- EventFolder
- EventFolderCreated
- EventFolderDeleted
- EventFolderUpdated
- EventGap
- EventGapDetected
- EventGroup
- EventGroupCreated
- EventGroupDeleted
- EventGroupMemberAdded
- EventGroupMemberRemoved
- EventGroupUpdated
- EventImportDocumentFailed
- EventImportSyncCompleted
- EventInvoice
- EventInvoiceIssued
- EventInvoicePaid
- EventJob
- EventJobCompleted
- EventJobFailed
- EventPlace
- EventQuestion
- EventQuestionAnswered
- EventQuestionFeedbackCreated
- EventQuestionUnanswered
- EventSource
- EventSourceConnectionLost
- EventSourceSyncCompleted
- EventSourceSyncFailed
- EventSubscription
- EventSubscriptionUpdated
- EventSync
- EventUser
- EventUserCreated
- EventUserDeactivated
- EventUserOffboarded
- EventUserUpdated
- EventVerification
- EventVerificationExpired
- EventVerificationRequested
- EventWebhookEndpointDisabled
- EventWebhookPing
- ExpandedUser
- ExportFile
- FeedbackRequest
- FeedItem
- FileAuthor
- FileAuthorList
- FileExpiry
- FileExtend
- FileList
- FileOrigin
- FilePreview
- FileRow
- FinanceCategoryRef
- FinanceCategorySource
- FinanceConversion
- FinanceConverted
- FinanceCurrencyMode
- FinanceDimension
- FinanceFilter
- FinanceInvoicePage
- FinanceInvoiceRow
- FinanceListRequest
- FinanceMeasure
- FinancePartyRef
- FinancePaymentPage
- FinancePaymentRow
- FinanceReport
- FinanceReportRequest
- FinanceReportRow
- FinanceReportTotal
- FinanceUnconverted
- Folder
- FolderCard
- FolderCardList
- FolderColor
- FolderCreate
- FolderDeleteResult
- FolderIcon
- FolderNode
- FolderPathItem
- FolderPosition
- FolderTree
- FolderTreeList
- FolderUpdate
- FolderWithPath
- Followup
- FollowupList
- GapCluster
- GapFollowup
- GapFollowupCreate
- GapFollowupPatch
- GapsResponse
- GrantLevel
- GrantObject
- GrantObjectType
- GrantRole
- GrantSubject
- Group
- GroupActivity
- GroupCreate
- GroupDetail
- GroupKind
- GroupList
- GroupManagedBy
- GroupMember
- GroupUpdate
- GuardrailVerdict
- HealthFull
- HealthLimited
- HealthPublic
- HealthServices
- HealthServiceState
- IndexUpgradeResult
- InvoiceDirection
- Job
- JobActionResult
- JobExpanded
- JobsBatch
- JobsResponse
- JobsSummary
- JobStatus
- JobStreamError
- JobStreamEvent
- JobStreamJob
- JobStreamSnapshot
- JobStreamSummary
- JobWithCard
- LoginChoice
- MePermissions
- Metadata
- MetadataPatch
- Notification
- NotificationKind
- NumberProvenance
- OAuthApp
- OAuthAppCreate
- OAuthAppList
- OAuthAppUpdate
- OAuthAppWithSecret
- OAuthAuthorization
- OAuthAuthorizationList
- OAuthClientType
- OAuthErrorResponse
- OAuthRevokeRequest
- OAuthScope
- OAuthServerMetadata
- OAuthTokenRequest
- OAuthTokenResponse
- ObjectGrant
- ObjectGrantRequest
- ObjectPermissionList
- ObjectPermissions
- OffboardRequest
- OffboardResult
- OrgInfo
- OrgLimits
- OrgLogoInfo
- OrgStatus
- OrgUsage
- OrgUsageView
- PaymentDirection
- PendingAction
- PendingActionResult
- PendingActionStatus
- Permission
- PermissionArea
- PermissionList
- ProvenanceKind
- ProvenanceMatch
- ProvenancePart
- PushDocument
- PushDocumentBatch
- PushDocumentBatchResult
- PushDocumentReason
- PushDocumentResult
- PushDocumentStatus
- PushDocumentStatusExpanded
- PushDocumentStatusList
- PushDocumentStatusValue
- PushPermissions
- PushSourceInfo
- PushSyncClose
- PushSyncOpen
- PushTouch
- PushTouchResult
- PushVerifiers
- QuestionFeedbackFilter
- QuestionFeedbackResult
- QuestionLogList
- QuestionLogRow
- QuestionPayload
- QuestionRow
- QuestionsCsv
- QuestionSource
- QuestionSourceSlim
- QueueStats
- ReactionDetail
- RefreshChange
- RefreshResult
- ReindexCounts
- ReindexPlan
- ReindexResult
- ReindexSkipped
- RestrictedInfo
- ReviewWarning
- Role
- SaveCardRequest
- SaveCardResult
- SearchHit
- SearchRequest
- SearchResponse
- ServiceRef
- SimilarItem
- SimilarResponse
- Source
- SourceCreate
- SourceItemCounts
- SourceKind
- SourceObjectType
- SourcePushKey
- SourcePushKeyCreate
- SourcePushKeyIssued
- SourcePushKeyList
- SourcePushSync
- SourcePushSyncList
- SourceRun
- SourceRunning
- SourceRunStatus
- SourceSettingsUpdate
- SourceStats
- SourceStatus
- SourceTrigger
- SourceUpdate
- SpendCategory
- SpendGroup
- SpendTaxonomy
- StatusOk
- StatusRevoked
- TableDiffItem
- TableProfile
- TableQuery
- TableRow
- TableRows
- TagList
- TaskScope
- TasksDetail
- TasksLegacy
- TextCardRequest
- TextCardResult
- Thread
- ThreadList
- ThreadUpdate
- Timings
- ToolCallInfo
- ToolName
- TrustParts
- TrustPoint
- TrustScore
- TurnVersions
- UnfinishedTurn
- UnverifyRequest
- Upload
- UploadComplete
- UploadCreate
- UploadPart
- UploadPartRef
- UploadPurpose
- UploadResult
- UploadStatus
- UsageDay
- UsageItem
- User
- UserActivityRow
- UserBrief
- UserBriefList
- UserCreate
- UserRowSlim
- UsersImportAction
- UsersImportCounts
- UsersImportInvitation
- UsersImportLimit
- UsersImportRequest
- UsersImportResult
- UsersImportRow
- UsersImportRowError
- UserUpdate
- ValidationError
- Verification
- VerificationEvent
- VerificationIntervalUpdate
- VerificationQueue
- VerificationQueueItem
- VerificationReason
- VerificationState
- VerificationType
- Verifier
- VerifierRef
- VerifierSet
- VerifierType
- VerifyCardRequest
- VerifyRequest
- ViewAs
- ViewAsOrg
- WebhookAttempt
- WebhookAttemptList
- WebhookAuthInput
- WebhookCatalog
- WebhookCatalogItem
- WebhookCreate
- WebhookCreated
- WebhookDelivery
- WebhookDeliveryBody
- WebhookDeliveryDetail
- WebhookDeliveryExpanded
- WebhookDeliveryList
- WebhookDeliveryStatus
- WebhookEndpoint
- WebhookEndpointList
- WebhookEvent
- WebhookEventFilter
- WebhookEventList
- WebhookEventObject
- WebhookEventType
- WebhookHeader
- WebhookHeaderInput
- WebhookHealth
- WebhookPayloadMode
- WebhookRedeliverRange
- WebhookRedeliverResult
- WebhookRole
- WebhookRotateSecret
- WebhookSecret
- WebhookStatus
- WebhookTestRequest
- WebhookUpdate