.NET

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

RequisitosCopiar enlace del ancla

• .NET 8+

InstalaciónCopiar enlace del ancla

dotnet add package CaptureKit

Obtén tu clave de APICopiar enlace del ancla

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

Inicio rápidoCopiar enlace del ancla

using CaptureKit;

using var client = new CaptureKitClient();
var response = await client.ContentAsync(new ContentParams { Url = "https://example.com" });
Console.WriteLine(response.Json);

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.

var submitted = await client.ContentAsync(new ContentParams { Url = "https://example.com", IsAsync = true });
var job = await client.WaitForJobAsync(
    submitted.Json.GetProperty("job_id").GetString()!,
    onProgress: j => Console.WriteLine($"{j.GetProperty("status")} {j.GetProperty("progress")}%"));

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.

try
{
    await client.ContentAsync(new ContentParams { Url = "https://example.com" });
}
catch (CaptureKitApiException exception)
{
    Console.Error.WriteLine($"{exception.StatusCode}: {exception.Message}");
}

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.

using var client = new CaptureKitClient(new CaptureKitClientOptions { MaxRetries = 5, RetryDelay = TimeSpan.FromMilliseconds(500) });
await client.ContentAsync(new ContentParams { Url = "https://example.com" }, new RequestOptions { MaxRetries = 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.

string[] inputs = { "https://example.com", "https://www.capturekit.dev", "https://github.com" };
var results = await client.BatchAsync(inputs, (value, ct) =>
    client.ContentAsync(new ContentParams { Url = value }, cancellationToken: ct), concurrency: 5);
foreach (var result in results)
{
    if (result.Ok)
    {
        Console.WriteLine(result.Value!.Json);
    }
    else
    {
        Console.Error.WriteLine($"{inputs[result.Index]}: {result.Error!.Message}");
    }
}

Cualquier endpointCopiar enlace del ancla

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

var response = await client.RequestAsync("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: CaptureKit
• Código fuente: github.com/capturekitdev/capturekit-dotnet
• Referencia de la API