Ruby

O SDK Ruby oficial da CaptureKit, com um método tipado por endpoint e um request() genérico para o resto.

RequisitosCopiar link da âncora

• Ruby 3.1+

InstalaçãoCopiar link da âncora

gem install capturekitdev

gem "capturekitdev"

Obtenha sua chave de APICopiar link da âncora

Copie sua chave de API no painel da CaptureKit e coloque-a na variável de ambiente CAPTUREKIT_API_KEY, que o SDK lê por padrão. Não a inclua no controle de versão.

Início rápidoCopiar link da âncora

require "capturekit"

client = CaptureKit::Client.new(api_key: ENV.fetch("CAPTUREKIT_API_KEY"))
response = client.content(url: "https://example.com")
puts response.data

Jobs assíncronosCopiar link da âncora

Qualquer chamada aceita is_async, útil além do limite de 60 segundos do servidor. A resposta é então um job_id, e o SDK pode aguardar o fim do job.

submitted = client.content(url: "https://example.com", is_async: true)
job = client.wait_for_job(submitted.data["job_id"]) { |j| puts "#{j['status']} #{j['progress']}%" }
puts job.data

ErrosCopiar link da âncora

Uma resposta fora de 2xx gera um erro de API com status e mensagem. Veja os códigos de status para a lista completa.

begin
  client.content(url: "https://example.com")
rescue CaptureKit::APIError => e
  warn "HTTP #{e.status}: #{e.message}"
end

Novas tentativasCopiar link da âncora

As requisições são repetidas até 3 vezes após um erro de rede, um 408, 500, 502, 503 ou 504, ou um limite de taxa do plano. Erros de cota por chave e timeouts do cliente não são repetidos. A espera começa em 1 segundo e cresce 1,5× a cada tentativa, e um cabeçalho Retry-After tem prioridade.

client = CaptureKit::Client.new(max_retries: 5, retry_delay: 0.5)
client.content(url: "https://example.com", request_options: { max_retries: 0 }) # one request without retries

Requisições em loteCopiar link da âncora

Execute muitas chamadas de uma vez, 10 por padrão. Uma falha não interrompe as outras.

inputs = ["https://example.com", "https://www.capturekit.dev", "https://github.com"]
results = client.batch(inputs, concurrency: 5) { |value| client.content(url: value) }
results.each do |result|
  if result.ok?
    puts result.value.data
  else
    warn "#{inputs[result.index]}: #{result.error.message}"
  end
end

Qualquer endpointCopiar link da âncora

request() alcança qualquer caminho, inclusive endpoints lançados depois da sua versão do SDK.

response = client.request("GET", "/v1/usage")

Erros comunsCopiar link da âncora

• Colocar a chave de API no código front-end. Qualquer pessoa poderia lê-la. Chame a API a partir do seu servidor.
• Tratar todo 401 como chave incorreta. Um 401 também pode ser um limite de taxa: leia a mensagem. O SDK repete automaticamente os limites do plano.
• Repetir um 402. Não há mais créditos nem cota, então uma nova tentativa não pode funcionar. Veja Créditos.
• Esperar requisições longas. Acima de 60 segundos, use o modo assíncrono como mostrado acima em vez de aumentar o timeout. Veja Timeout.

LinksCopiar link da âncora

• Pacote: capturekitdev
• Código-fonte: github.com/capturekitdev/capturekit-ruby
• Referência da API