CaptureKit

Go

Instale o SDK Go da CaptureKit e faça sua primeira chamada à API.

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

Requisitos

  • Go 1.22+

Instalação

go get github.com/capturekitdev/capturekit-go

Obtenha sua chave de API

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ápido

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/capturekitdev/capturekit-go"
)

func main() {
	client, err := capturekit.NewClient("", nil) // reads CAPTUREKIT_API_KEY
	if err != nil {
		log.Fatal(err)
	}
	ctx := context.Background()
	response, err := client.Content(ctx, &capturekit.ContentParams{URL: "https://example.com"})
	if err != nil {
		log.Fatal(err)
	}
	data, err := response.Map()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(data)
}

Jobs assíncronos

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.

submitted, err := client.Content(ctx, &capturekit.ContentParams{URL: "https://example.com", IsAsync: capturekit.Bool(true)})
if err != nil {
	log.Fatal(err)
}
var accepted struct{ JobID string `json:"job_id"` }
if err := submitted.Decode(&accepted); err != nil {
	log.Fatal(err)
}
job, err := client.WaitForJob(ctx, accepted.JobID, &capturekit.WaitForJobOptions{
	OnProgress: func(job map[string]any) { fmt.Println(job["status"], job["progress"]) },
})

Erros

Uma resposta fora de 2xx gera um erro de API com status e mensagem. Veja os códigos de status para a lista completa.

response, err := client.Content(ctx, &capturekit.ContentParams{URL: "https://example.com"})
if apiError, ok := capturekit.IsAPIError(err); ok {
	log.Printf("HTTP %d: %s", apiError.StatusCode, apiError.Message)
}

Novas tentativas

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.

client, err := capturekit.NewClient("", &capturekit.ClientOptions{
	MaxRetries: 5,                      // negative disables retries
	RetryDelay: 500 * time.Millisecond,
})

// or for one request
response, err := client.Content(ctx, &capturekit.ContentParams{URL: "https://example.com"}, capturekit.WithMaxRetries(0))

Requisições em lote

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

inputs := []string{"https://example.com", "https://www.capturekit.dev", "https://github.com"}
results := capturekit.Batch(ctx, inputs, 5, func(ctx context.Context, value string) (*capturekit.Response, error) {
	return client.Content(ctx, &capturekit.ContentParams{URL: value})
})
for _, result := range results {
	if result.Err != nil {
		log.Printf("%s: %v", inputs[result.Index], result.Err)
		continue
	}
	fmt.Println(string(result.Value.Body))
}

Qualquer endpoint

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

response, err := client.Request(ctx, "GET", "/v1/usage", nil)

Erros comuns

  • 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.

Nesta página