Docs›Schnellstart

Schnellstart

Installieren Sie das SDK, holen Sie sich Ihren API Key und schuetzen Sie Ihre erste Anfrage in unter 5 Minuten.

SDK installieren

Installieren Sie @grepture/sdk mit dem Paketmanager Ihrer Wahl:

npm install @grepture/sdk

Oder mit pnpm, yarn oder bun:

pnpm add @grepture/sdk
bun add @grepture/sdk

API Key erhalten

1. Registrieren Sie sich unter grepture.com/en/pricing -- der kostenlose Plan umfasst 1.000 Anfragen/Monat und 25 AI-Detection-Anfragen/Monat
2. Oeffnen Sie das Dashboard und navigieren Sie zur API-Seite in der Seitenleiste
3. Kopieren Sie Ihren API Key (Format: gpt_...)

Speichern Sie den Key in Ihrer Umgebung:

export GREPTURE_API_KEY=gpt_your_key_here

Grepture-Client erstellen

Importieren Sie die Grepture-Klasse und erstellen Sie eine Instanz mit Ihrem API Key und Ihrer Proxy-URL:

import { Grepture } from "@grepture/sdk";

const grepture = new Grepture({
  apiKey: process.env.GREPTURE_API_KEY!,
  proxyUrl: "https://proxy.grepture.com",
});

OpenAI-Client einbinden

Verwenden Sie grepture.clientOptions(), um die Konfiguration fuer Ihren OpenAI-Client zu erhalten. Uebergeben Sie Ihren OpenAI API Key und die Base-URL -- Grepture leitet die Anfrage ueber den Proxy und wendet Ihre Erkennungsregeln an, bevor sie OpenAI erreicht.

import OpenAI from "openai";
import { Grepture } from "@grepture/sdk";

const grepture = new Grepture({
  apiKey: process.env.GREPTURE_API_KEY!,
  proxyUrl: "https://proxy.grepture.com",
});

const openai = new OpenAI({
  ...grepture.clientOptions({
    apiKey: process.env.OPENAI_API_KEY!,
    baseURL: "https://api.openai.com/v1",
  }),
});

const response = await openai.chat.completions.create({
  model: "gpt-4o",
  messages: [{ role: "user", content: "Hello, world!" }],
});

Das funktioniert mit jedem OpenAI-kompatiblen Anbieter -- aendern Sie einfach die baseURL und den apiKey passend zu Ihrem Anbieter.

Beliebige HTTP-Aufrufe schuetzen

Fuer Traffic ausserhalb des SDK koennen Sie grepture.fetch() als direkten Ersatz fuer fetch verwenden:

import { Grepture } from "@grepture/sdk";

const grepture = new Grepture({
  apiKey: process.env.GREPTURE_API_KEY!,
  proxyUrl: "https://proxy.grepture.com",
});

const response = await grepture.fetch("https://api.example.com/data", {
  method: "POST",
  body: JSON.stringify({ message: "Hello from my app" }),
});

const data = await response.json();

Die zurueckgegebene GreptureResponse umschliesst eine Standard-Response und ergaenzt die Properties requestId, rulesApplied und aiSampling, damit Sie nachvollziehen koennen, was passiert ist.

Funktionstest

Nachdem Sie Ihre erste Anfrage gesendet haben, oeffnen Sie das Grepture-Dashboard. Sie sollten Folgendes sehen:

• Die Anfrage im Traffic Log
• Erkannte PII oder Secrets, hervorgehoben mit der ausgefuehrten Aktion (Redact, Mask, Block oder Log)
• Aktualisierte Statistiken in der Dashboard-Uebersicht

Naechste Schritte

• SDK-Referenz -- vollstaendige API-Oberflaeche, Fehlerbehandlung und TypeScript-Typen
• Konfiguration -- Erkennungsregeln, benutzerdefinierte Muster und Zero-Data-Modus
• Dashboard -- Traffic-Monitoring, Regelverwaltung und Abrechnung