POST/v1/sources

Skapa en källa

create_source

Med en API-nyckel för organisationen (från och med 1.62.0) är bara en egen källa (kind: custom) tillgänglig: nyckeln behöver rollen admin och omfånget admin. Alla andra typer returnerar 400 sources.kind_not_allowed_for_key; connectorer som loggar in hos leverantören konfigureras i webbläsaren. Connectorernas fält visas inte i den offentliga specifikationen. En egen källa tar emot name, samlingen (collection_id eller collection), behörighetsläget permissions_mode, samlingens mapp för kort (folder_id och folder_mode) och de valda dokumentmapparna (roots). Dokument skickas med åtgärderna /v1/push/sources/{source_id}/*.

Autentisering

Skicka en API-nyckel i huvudet Authorization: Authorization: Bearer <nyckel>.

Parametrar i huvuden

X-View-Asstring
Bara för API-nycklar med rollen admin. Gör anropet som dataprofilen <profile>[:viewer|verifier|editor], till exempel employee:viewer. Installationsnyckeln kan inte använda det här huvudet (403).
Idempotency-Keystring
Nyckel för ett säkert nytt försök med en skrivning: 1–255 utskrivbara ASCII-tecken; ett UUID v4 per logisk åtgärd rekommenderas. Ett nytt försök med samma nyckel inom 24 timmar kör inte åtgärden igen, utan returnerar det sparade svaret (status, huvuden och brödtext) med huvudet Idempotency-Replayed: true. Samma nyckel med en annan metod, sökväg, Content-Type eller brödtext returnerar 409 api.idempotency_mismatch; medan det första anropet fortfarande pågår returneras 409 api.idempotency_in_progress med Retry-After: 1. Efter ett 5xx- eller 429-svar frigörs nyckeln, och ett nytt försök kör åtgärden igen. Nyckeln gäller inom organisationen och för anroparen (API-nyckel, användare eller källnyckel för en egen källa).
length ≥ 1, length ≤ 255

Cookie-parametrar

kb_view_asstring
Cookie för läget ”View as” (visa som en annan användare) i en session. POST /auth/view-as sätter den och DELETE /auth/view-as tar bort den.

Anropets brödtext

application/json

Objekt: SourceCreate

kindstring
Källans typ (se SourceKind); med organisationens API-nyckel bara custom.
Standard: "gdrive"
namestringobligatorisk
length ≥ 1, length ≤ 120
collectionstring
Namnet på källans samling; du kan skicka collection_id i stället (sedan 1.62.0).
length ≥ 1, length ≤ 64
collection_idinteger
Källans samling efter id (sedan 1.62.0); om båda skickas har collection_id företräde.
permissions_modestring
Behörighetsläge för källans kort (sedan 1.62.0, som i update_source_settings): own använder samlingens behörigheter, mirror tar dem från dokumentet (permissions). För att välja mirror krävs rätt att hantera samlingens behörigheter.
Tillåtna värden: ownmirror
default_owner_idinteger | null
verify_interval_daysinteger
Standard: 90≥ 1, ≤ 3650
tagsarray of string
Standard: []
default_categorystring | null
rootsarray of string | null
Valda mappar i källan: bara objekt i dem blir kort. För en egen källa: dokumentens mappsökvägar (Guides/Billing); för connectorer: noder i leverantörens träd.
folder_idstring | null
Mapp i källans samling där korten placeras (null betyder samlingens rotnivå).
folder_modestring
flat lägger allt i den valda mappen; mirror skapar mappar som återger objektets sökväg i källan, högst till gränsen för mappnästling (3 nivåer; djupare objekt hamnar i närmaste mapp).
Tillåtna värden: flatmirror
Standard: "flat"

Svar

200Lyckat svar

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.
Idempotency-Replayed
true betyder att svaret spelades upp från det sparade svaret för denna Idempotency-Key: åtgärden kördes inte igen.

application/json

Objekt: DataSource

Ett av

400Anropet är ogiltigt: ett parametervärde eller objektets tillstånd tillåter inte åtgärden (`detail` är ett meddelande).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

401Inga autentiseringsuppgifter skickades (varken en sessionscookie eller en API-nyckel), eller så hittades inte nyckeln.

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

403Åtgärden är inte tillåten: rollen räcker inte, det saknas åtkomst till samlingen eller kortet, anropet körs i läget ”View as” (visa som en annan användare), eller organisationen är avstängd eller borttagen (`detail` är ett objekt med `code: org_suspended | org_deleted`).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

404Objektet finns inte eller är inte tillgängligt för dig. API:et bekräftar inte att ett begränsat objekt finns.

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

422Valideringsfel: brödtexten eller parametrarna stämmer inte med schemat (`detail` är en lista med valideringsfel), eller så ligger ett parametervärde utanför det tillåtna intervallet (`detail` är ett meddelande).

Svarshuvuden

RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

429För många anrop (`api.rate_limited`), organisationens kvot för minuten, dygnet eller månaden är förbrukad (`api.quota_exceeded`; `error.details` innehåller `quota`, `limit` och `reset_at`), organisationens gräns är nådd eller svarstjänsten är upptagen (`answers.engine_busy`). Vänta den tid som anges i huvudet `Retry-After`.

Svarshuvuden

Retry-After
Antal sekunder att vänta innan du skickar anropet igen.
RateLimit-Policy
Gällande gränser i formatet från IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerade poster "<name>";q=<quota>;w=<window in seconds>. key är API-nyckelns anropsfrekvens (kvoten är toppen (burst), fönstret är tiden tills den har fyllts på helt; för en session är det user, utan autentiseringsuppgifter ip); minute, day och month är organisationens kvoter för kalenderminuten, kalenderdygnet och kalendermånaden i UTC.
RateLimit
Vad som återstår av varje gräns i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Gränsen för den striktaste posten i RateLimit-Policy (den med minst antal återstående anrop).
X-RateLimit-Remaining
Återstående anrop inom den striktaste gränsen.
X-RateLimit-Reset
Sekunder tills den striktaste gränsen nollställs.

application/json

Objekt: Error

Felkoder

Koder som den här slutpunkten kan returnera i error.code, utöver de allmänna koderna för alla anrop.

Säkra nya försök

Skicka huvudet Idempotency-Key (till exempel ett UUID) med varje POST och PATCH. Ett nytt försök med samma nyckel inom 24 timmar returnerar det sparade svaret i stället för att köra anropet igen.

Hastighetsbegränsningar

Svaren innehåller huvudena RateLimit och RateLimit-Policy samt de tidigare X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset. Ett 429-svar har Retry-After i sekunder: vänta och försök igen.

← sources · API-referens

curl -X POST 'https://api.sursa.com/v1/sources' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"kind":"custom","name":"Help center import","collection":"support"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Prova

API-nyckel

Nyckeln finns bara i den här flikens minne och skickas bara till https://api.sursa.com.

Anropen påverkar din organisations riktiga data.

X-View-As header

Idempotency-Key header

Idempotency-Key

Är fältet tomt skapas en ny nyckel för varje anrop.

Anropets brödtext (JSON)