Ruby

El SDK oficial de Ruby de Veille, con un método tipado por endpoint y un request() genérico para lo demás.

RequisitosCopiar enlace del ancla

• Ruby 3.1+

InstalaciónCopiar enlace del ancla

gem install veille

gem "veille"

Obtén tu clave de APICopiar enlace del ancla

Copia tu clave de API desde el panel de Veille y guárdala en la variable de entorno VEILLE_API_KEY, que el SDK lee por defecto. No la incluyas en el control de versiones.

Inicio rápidoCopiar enlace del ancla

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

Trabajos asíncronosCopiar enlace del ancla

Cualquier llamada acepta is_async, útil más allá del límite de 60 segundos del servidor. La respuesta es entonces un job_id, y el SDK puede esperar a que termine el trabajo.

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

ErroresCopiar enlace del ancla

Una respuesta fuera de 2xx lanza un error de API con su estado y su mensaje. Consulta los códigos de estado para ver la lista completa.

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

ReintentosCopiar enlace del ancla

Las solicitudes se reintentan hasta 3 veces tras un error de red, un 408, 500, 502, 503 o 504, o un límite de frecuencia del plan. Los errores de cuota por clave y los tiempos de espera del cliente no se reintentan. La espera empieza en 1 segundo y crece 1,5× en cada reintento, y una cabecera Retry-After tiene prioridad.

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

Solicitudes por lotesCopiar enlace del ancla

Ejecuta muchas llamadas a la vez, 10 por defecto. Un fallo no detiene las demás.

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

Cualquier endpointCopiar enlace del ancla

request() llega a cualquier ruta, incluidos los endpoints publicados después de tu versión del SDK.

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

Errores frecuentesCopiar enlace del ancla

• Poner la clave de API en el código front-end. Cualquiera podría leerla. Llama a la API desde tu servidor.
• Tratar todo 401 como una clave incorrecta. Un 401 también puede ser un límite de frecuencia: lee el mensaje. El SDK reintenta por ti los límites del plan.
• Reintentar un 402. Significa que no quedan créditos ni cuota, así que un reintento no puede funcionar. Consulta Créditos.
• Esperar solicitudes largas. Más allá de 60 segundos, usa el modo asíncrono como se muestra arriba en lugar de aumentar el tiempo de espera. Consulta Timeout.

EnlacesCopiar enlace del ancla

• Paquete: veille
• Código fuente: github.com/veilleio/veille-ruby
• Referencia de la API