.NET

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

RequisitosCopiar link da âncora

• .NET 8+

InstalaçãoCopiar link da âncora

dotnet add package CaptureKit

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

using CaptureKit;

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

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.

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")}%"));

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.

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

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.

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

Requisições em loteCopiar link da âncora

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

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}");
    }
}

Qualquer endpointCopiar link da âncora

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

var response = await client.RequestAsync("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: CaptureKit
• Código-fonte: github.com/capturekitdev/capturekit-dotnet
• Referência da API