POST/v1/sources

Criar uma fonte

create_source

Com uma chave de API da organização (desde a versão 1.62.0), só uma fonte personalizada (kind: custom) está disponível: a chave precisa da função admin e do escopo admin. Qualquer outro tipo retorna 400 sources.kind_not_allowed_for_key; os conectores que fazem login no provedor são configurados no navegador. Os campos dos conectores não aparecem na especificação pública. Uma fonte personalizada recebe name, a coleção (collection_id ou collection), o modo de permissões permissions_mode, a pasta da coleção para os cartões (folder_id e folder_mode) e as pastas de documentos selecionadas (roots). Os documentos são enviados com as operações /v1/push/sources/{source_id}/*.

Autenticação

Envie uma chave de API no cabeçalho Authorization: Authorization: Bearer <chave>.

Parâmetros de cabeçalho

X-View-Asstring
Só para chaves de API com a função admin. Faz a requisição como o perfil de dados <profile>[:viewer|verifier|editor], por exemplo, employee:viewer. A chave de instalação não pode usar este cabeçalho (403).
Idempotency-Keystring
Chave para uma nova tentativa segura de uma gravação: de 1 a 255 caracteres ASCII imprimíveis; recomenda-se um UUID v4 por operação lógica. Uma nova tentativa com a mesma chave dentro de 24 horas não executa a operação de novo: retorna a resposta salva (status, cabeçalhos e corpo) com o cabeçalho Idempotency-Replayed: true. A mesma chave com outro método, caminho, Content-Type ou corpo retorna 409 api.idempotency_mismatch; enquanto a primeira requisição ainda está em execução, 409 api.idempotency_in_progress com Retry-After: 1. Depois de uma resposta 5xx ou 429, a chave é liberada, e uma nova tentativa executa a operação de novo. A chave vale para a organização e para quem faz a chamada (chave de API, usuário ou chave de fonte personalizada).
length ≥ 1, length ≤ 255

Parâmetros de cookie

kb_view_asstring
Cookie do modo “View as” (ver a base como um perfil de dados a vê) de uma sessão. POST /auth/view-as o define e DELETE /auth/view-as o remove.

Corpo da requisição

application/json

Objeto: SourceCreate

kindstring
Tipo da fonte (ver SourceKind); com uma chave de API da organização, só custom.
Padrão: "gdrive"
namestringobrigatório
length ≥ 1, length ≤ 120
collectionstring
Nome da coleção da fonte; em vez dele, é possível passar collection_id (desde a versão 1.62.0).
length ≥ 1, length ≤ 64
collection_idinteger
Coleção da fonte pelo ID (desde a versão 1.62.0); se os dois forem passados, prevalece collection_id.
permissions_modestring
Modo de permissões dos cartões da fonte (desde a versão 1.62.0, como em update_source_settings): own usa as permissões da coleção, mirror as obtém do documento (permissions). Escolher mirror exige o direito de gerenciar as permissões da coleção.
Valores permitidos: ownmirror
default_owner_idinteger | null
verify_interval_daysinteger
Padrão: 90≥ 1, ≤ 3650
tagsarray of string
Padrão: []
default_categorystring | null
rootsarray of string | null
Pastas selecionadas da fonte: só os itens dentro delas se tornam cartões. Para uma fonte personalizada, os caminhos de pastas dos documentos (Guides/Billing); para os conectores, nós da árvore do provedor.
folder_idstring | null
Pasta da coleção da fonte em que os cartões são colocados (null significa a raiz da coleção).
folder_modestring
flat coloca tudo na pasta selecionada; mirror cria pastas que repetem o caminho do item na fonte, sem passar do limite de aninhamento de pastas (3 níveis; itens mais profundos vão para a pasta mais próxima).
Valores permitidos: flatmirror
Padrão: "flat"

Respostas

200Resposta bem-sucedida

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.
Idempotency-Replayed
true significa que a resposta foi reproduzida a partir da resposta salva para esta Idempotency-Key: a operação não foi executada de novo.

application/json

Objeto: DataSource

Um de

400A requisição é inválida: o valor de um parâmetro ou o estado do objeto não permite a ação (`detail` é uma mensagem).

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

401Nenhuma credencial foi enviada (nem cookie de sessão nem chave de API), ou a chave não foi encontrada.

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

403A ação não é permitida: a função é insuficiente, não há acesso à coleção ou ao cartão, a requisição é executada no modo “View as” ou a organização está suspensa ou excluída (`detail` é um objeto com `code: org_suspended | org_deleted`).

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

404O objeto não existe ou não está disponível para você. A API não confirma que um objeto restrito existe.

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

422Erro de validação: o corpo ou os parâmetros não correspondem ao esquema (`detail` é uma lista de erros de validação), ou o valor de um parâmetro está fora do intervalo (`detail` é uma mensagem).

Cabeçalhos da resposta

RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

429Requisições demais (`api.rate_limited`), a cota da organização para o minuto, o dia ou o mês se esgotou (`api.quota_exceeded`; `error.details` contém `quota`, `limit` e `reset_at`), o limite da organização foi atingido ou o serviço de respostas está ocupado (`answers.engine_busy`). Aguarde o tempo indicado no cabeçalho `Retry-After`.

Cabeçalhos da resposta

Retry-After
Número de segundos a esperar antes de tentar a requisição novamente.
RateLimit-Policy
Limites em vigor, no formato do rascunho da IETF draft-ietf-httpapi-ratelimit-headers: itens separados por vírgula "<name>";q=<quota>;w=<window in seconds>. key é a taxa de requisições da chave de API (a cota é a rajada, a janela é o tempo para reabastecê-la por completo; para uma sessão é user, sem credenciais é ip); minute, day e month são as cotas da organização para o minuto, o dia e o mês do calendário em UTC.
RateLimit
O que resta de cada limite de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limite da entrada mais restritiva de RateLimit-Policy (a que tem menos requisições restantes).
X-RateLimit-Remaining
Requisições restantes no limite mais restritivo.
X-RateLimit-Reset
Segundos até o limite mais restritivo ser reiniciado.

application/json

Objeto: Error

Códigos de erro

Códigos que este endpoint pode retornar em error.code, além dos códigos gerais de qualquer requisição.

Novas tentativas seguras

Envie um cabeçalho Idempotency-Key (por exemplo, um UUID) em cada POST e PATCH. Uma nova tentativa com a mesma chave em até 24 horas retorna a resposta salva, em vez de executar a requisição de novo.

Limites de taxa

As respostas trazem os cabeçalhos RateLimit e RateLimit-Policy e os anteriores X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset. Uma resposta 429 traz Retry-After em segundos: aguarde e tente de novo.

← sources · Referência da API

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"

Testar

Chave de API

A chave fica na memória desta aba e é enviada só para https://api.sursa.com.

As requisições atuam sobre os dados reais da sua organização.

X-View-As header

Idempotency-Key header

Idempotency-Key

Com o campo vazio, uma nova chave é gerada para cada requisição.

Corpo da requisição (JSON)