Request-IDs & Debugging

Jede neuroflash API-Antwort enthält Header, die Ihnen helfen, Anfragen nachzuverfolgen und zu debuggen.

Der x-request-id-Header

Jede API-Antwort enthält einen x-request-id-Header mit einer UUID v4, die die Anfrage eindeutig identifiziert:

x-request-id: 3f2504e0-4f89-11d3-9a0c-0305e82c3301

Geben Sie diese ID immer an, wenn Sie den Support kontaktieren — sie ermöglicht es dem Team, Ihre exakte Anfrage in den Systemprotokollen zu finden und Probleme schnell zu diagnostizieren.

Request-ID erfassen

cURL

Verwenden Sie das -v-Flag (verbose), um die Antwort-Header anzuzeigen:

curl -v https://app.neuroflash.com/api/digital-twin-service/v1/static-groups \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Suchen Sie die Zeile x-request-id in der Ausgabe:

< x-request-id: 3f2504e0-4f89-11d3-9a0c-0305e82c3301

Python

import requests

response = requests.get(
    "https://app.neuroflash.com/api/digital-twin-service/v1/static-groups",
    headers={"Authorization": f"Bearer {token}"},
)

request_id = response.headers.get("x-request-id")
print(f"Request ID: {request_id}")

if not response.ok:
    print(f"Error {response.status_code}: {response.text}")
    print(f"Include this request ID in your support ticket: {request_id}")

Node.js

const response = await fetch(
  "https://app.neuroflash.com/api/digital-twin-service/v1/static-groups",
  {
    headers: { Authorization: `Bearer ${access_token}` },
  }
);

const requestId = response.headers.get("x-request-id");
console.log(`Request ID: ${requestId}`);

if (!response.ok) {
  console.error(`Error ${response.status}: ${await response.text()}`);
  console.error(`Include this request ID in your support ticket: ${requestId}`);
}

Go

req, _ := http.NewRequest("GET",
	"https://app.neuroflash.com/api/digital-twin-service/v1/static-groups", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

requestID := resp.Header.Get("x-request-id")
fmt.Printf("Request ID: %s\n", requestID)

if resp.StatusCode >= 400 {
	body, _ := io.ReadAll(resp.Body)
	fmt.Printf("Error %d: %s\n", resp.StatusCode, body)
	fmt.Printf("Include this request ID in your support ticket: %s\n", requestID)
}

tipp

Protokollieren Sie die x-request-id bei jedem API-Aufruf in der Produktion. Wenn etwas schiefgeht, haben Sie bereits die Informationen, die für schnellen Support benötigt werden.

Der x-cloud-trace-context-Header

Antworten können auch einen x-cloud-trace-context-Header enthalten:

x-cloud-trace-context: 105445aa7843bc8bf206b12000100000/1;o=1

Dies ist eine Trace-ID auf Infrastrukturebene, die intern verwendet wird. Sie müssen sie nicht direkt verwenden, können sie aber zusammen mit der x-request-id bei der Meldung von Problemen angeben, um zusätzlichen Diagnosekontext bereitzustellen.