Ruby

Le SDK Ruby officiel de CaptureKit, avec une méthode typée par endpoint et un request() générique pour le reste.

PrérequisCopier le lien de l'ancre

• Ruby 3.1+

InstallationCopier le lien de l'ancre

gem install capturekitdev

gem "capturekitdev"

Obtenir votre clé APICopier le lien de l'ancre

Copiez votre clé API depuis le tableau de bord CaptureKit et placez-la dans la variable d'environnement CAPTUREKIT_API_KEY, que le SDK lit par défaut. Ne la versionnez pas.

Démarrage rapideCopier le lien de l'ancre

require "capturekit"

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

Jobs asynchronesCopier le lien de l'ancre

Tout appel accepte is_async, utile au-delà de la limite serveur de 60 secondes. La réponse est alors un job_id, et le SDK peut attendre la fin du 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

ErreursCopier le lien de l'ancre

Une réponse hors 2xx lève une erreur d'API avec son statut et son message. Consultez les codes de statut pour la liste complète.

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

Nouvelles tentativesCopier le lien de l'ancre

Les requêtes sont retentées jusqu'à 3 fois après une erreur réseau, un 408, 500, 502, 503 ou 504, ou une limite de débit du forfait. Les erreurs de quota par clé et les expirations côté client ne sont pas retentées. Le délai commence à 1 seconde et augmente de 1,5× à chaque tentative, et un en-tête Retry-After a la priorité.

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

Requêtes par lotsCopier le lien de l'ancre

Lancez plusieurs appels à la fois, 10 par défaut. Un échec n'arrête pas les autres.

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

N'importe quel endpointCopier le lien de l'ancre

request() atteint n'importe quel chemin, y compris les endpoints sortis après votre version du SDK.

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

Erreurs fréquentesCopier le lien de l'ancre

• Mettre la clé API dans le code front-end. N'importe qui pourrait la lire. Appelez l'API depuis votre serveur.
• Considérer tout 401 comme une mauvaise clé. Un 401 peut aussi signaler une limite de débit : lisez le message. Le SDK retente pour vous les limites du forfait.
• Retenter un 402. Il n'y a plus de crédits ni de quota, donc une nouvelle tentative ne peut pas réussir. Consultez Crédits.
• Attendre les requêtes longues. Au-delà de 60 secondes, utilisez le mode asynchrone comme ci-dessus plutôt que d'augmenter votre délai. Voir Timeout.

LiensCopier le lien de l'ancre

• Paquet: capturekitdev
• Code source: github.com/capturekitdev/capturekit-ruby
• Référence API