Ruby

Das offizielle Ruby-SDK von Veille mit einer typisierten Methode pro Endpunkt und einem generischen request() für alles andere.

VoraussetzungenAnkerlink kopieren

• Ruby 3.1+

InstallationAnkerlink kopieren

gem install veille

gem "veille"

API-Schlüssel erhaltenAnkerlink kopieren

Kopieren Sie Ihren API-Schlüssel aus dem Veille-Dashboard und legen Sie ihn in der Umgebungsvariable VEILLE_API_KEY ab, die das SDK standardmäßig liest. Checken Sie ihn nicht in die Versionsverwaltung ein.

SchnellstartAnkerlink kopieren

require "veille"

client = Veille::Client.new(api_key: ENV.fetch("VEILLE_API_KEY"))
response = client.intelligence_email(query: "jane.doe@example.com")
puts response.data

Asynchrone JobsAnkerlink kopieren

Jeder Aufruf akzeptiert is_async, nützlich jenseits des Serverlimits von 60 Sekunden. Die Antwort ist dann eine job_id, und das SDK kann auf das Ende des Jobs warten.

submitted = client.intelligence_email(query: "jane.doe@example.com", is_async: true)
job = client.wait_for_job(submitted.data["job_id"]) { |j| puts "#{j['status']} #{j['progress']}%" }
puts job.data

FehlerAnkerlink kopieren

Eine Antwort außerhalb von 2xx löst einen API-Fehler mit Status und Meldung aus. Die vollständige Liste finden Sie unter Statuscodes.

begin
  client.intelligence_email(query: "jane.doe@example.com")
rescue Veille::APIError => e
  warn "HTTP #{e.status}: #{e.message}"
end

WiederholungenAnkerlink kopieren

Anfragen werden bis zu 3-mal wiederholt nach einem Netzwerkfehler, einem 408, 500, 502, 503 oder 504 oder einem Ratenlimit des Tarifs. Kontingentfehler pro Schlüssel und clientseitige Timeouts werden nicht wiederholt. Die Wartezeit beginnt bei 1 Sekunde und wächst pro Wiederholung um das 1,5-Fache; ein Retry-After-Header hat Vorrang.

client = Veille::Client.new(max_retries: 5, retry_delay: 0.5)
client.intelligence_email(query: "jane.doe@example.com", request_options: { max_retries: 0 }) # one request without retries

Batch-AnfragenAnkerlink kopieren

Führen Sie viele Aufrufe gleichzeitig aus, standardmäßig 10. Ein Fehler stoppt die anderen nicht.

inputs = ["jane.doe@example.com", "john@mailinator.com", "contact@veille.io"]
results = client.batch(inputs, concurrency: 5) { |value| client.intelligence_email(query: value) }
results.each do |result|
  if result.ok?
    puts result.value.data
  else
    warn "#{inputs[result.index]}: #{result.error.message}"
  end
end

Beliebiger EndpunktAnkerlink kopieren

request() erreicht jeden Pfad, auch Endpunkte, die nach Ihrer SDK-Version erschienen sind.

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

Häufige FehlerAnkerlink kopieren

• Den API-Schlüssel in Frontend-Code einbauen. Jeder könnte ihn lesen. Rufen Sie die API von Ihrem Server auf.
• Jeden 401 als falschen Schlüssel behandeln. Ein 401 kann auch ein Ratenlimit sein: Lesen Sie die Meldung. Das SDK wiederholt Tarif-Ratenlimits automatisch.
• Einen 402 wiederholen. Es sind keine Credits oder Kontingente mehr übrig, eine Wiederholung kann also nicht gelingen. Siehe Credits.
• Auf lange Anfragen warten. Nutzen Sie ab 60 Sekunden den asynchronen Modus wie oben gezeigt, statt das Timeout zu erhöhen. Siehe Timeout.

LinksAnkerlink kopieren

• Paket: veille
• Quellcode: github.com/veilleio/veille-ruby
• API-Referenz