Piloterr

Go

Installieren Sie das Go-SDK von Piloterr und starten Sie Ihren ersten API-Aufruf.

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

Voraussetzungen

  • Go 1.22+

Installation

go get github.com/piloterr/piloterr-go

API-Schlüssel erhalten

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

Schnellstart

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/piloterr/piloterr-go"
)

func main() {
	client, err := piloterr.NewClient("", nil) // reads PILOTERR_API_KEY
	if err != nil {
		log.Fatal(err)
	}
	ctx := context.Background()
	response, err := client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: "B09DFCB66S"})
	if err != nil {
		log.Fatal(err)
	}
	data, err := response.Map()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(data)
}

Asynchrone Jobs

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, err := client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: "B09DFCB66S", IsAsync: piloterr.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, &piloterr.WaitForJobOptions{
	OnProgress: func(job map[string]any) { fmt.Println(job["status"], job["progress"]) },
})

Fehler

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

response, err := client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: "B09DFCB66S"})
if apiError, ok := piloterr.IsAPIError(err); ok {
	log.Printf("HTTP %d: %s", apiError.StatusCode, apiError.Message)
}

Wiederholungen

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, err := piloterr.NewClient("", &piloterr.ClientOptions{
	MaxRetries: 5,                      // negative disables retries
	RetryDelay: 500 * time.Millisecond,
})

// or for one request
response, err := client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: "B09DFCB66S"}, piloterr.WithMaxRetries(0))

Batch-Anfragen

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

inputs := []string{"B09DFCB66S", "B0BSHF7WHW", "B08N5WRWNW"}
results := piloterr.Batch(ctx, inputs, 5, func(ctx context.Context, value string) (*piloterr.Response, error) {
	return client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: 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))
}

Beliebiger Endpunkt

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

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

Häufige Fehler

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

Auf dieser Seite