castomAPI
Odbierz klucz
POST /v1/proxy/webhook-relay 2 tokenów Klucz API Proxy

Bezpieczny Webhook Relay Proxy z generowaniem podpisu HMAC SHA-256

Bezpieczny Webhook Relay Proxy z generowaniem podpisu HMAC SHA-256, automatycznymi ponowieniami z exponential backoff oraz metrykami prób

POST

Żądanie

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Odpowiedź

{
  "attemptsLog": [
    {
      "attempt": 36,
      "error": "<error>",
      "latencyMs": 17,
      "statusCode": 200,
      "success": true
    }
  ],
  "delivered": true,
  "finalStatusCode": 200,
  "responseBody": {},
  "signatureAttached": true,
  "signatureHeaderName": "Ada Lovelace",
  "status": "success",
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 2,
  "totalAttempts": 3,
  "totalExecutionTimeMs": 3
}
Odpowiedź poniżej to makieta zbudowana ze schematu endpointu — żadne żądanie nie opuszcza tej strony. Zmień treść, naciśnij Wyślij, zobacz kształt odpowiedzi. Uruchom naprawdę w panelu →

Co robi

Bezpieczny Webhook Relay Proxy z generowaniem podpisu HMAC SHA-256, automatycznymi ponowieniami z exponential backoff oraz metrykami prób

Żądanie

Treść

PoleTypWymaganeOpis
customHeadersobjectnie
maxRetriesintegernieMaximum retry attempts for 5xx errors or connection timeouts
payloadobject | array | stringtakJSON object/array or raw string payload to deliver
secretstringnieOptional secret key used to generate HMAC SHA-256 signature
signatureEncodingenumnieOne of: hex, base64.
signatureHeaderstringnieHeader name under which the generated HMAC signature is attached
targetUrlstringtak
timeoutintegernieTimeout per HTTP request attempt in ms

Przykładowe żądanie

{
  "customHeaders": {},
  "maxRetries": 3,
  "payload": {},
  "secret": "<secret>",
  "signatureEncoding": "hex",
  "signatureHeader": "X-Signature-SHA256",
  "targetUrl": "https://example.com/page",
  "timeout": 5000
}

Odpowiedź

PoleTypOpis
attemptsLogarray<object>
  ↳ attemptinteger
  ↳ errorstring
  ↳ latencyMsinteger
  ↳ statusCodeinteger
  ↳ successboolean
deliveredboolean
finalStatusCodeinteger
responseBodyobject | array | string
signatureAttachedboolean
signatureHeaderNamestring
statusstring
targetUrlstring
tokensDeductedinteger
totalAttemptsinteger
totalExecutionTimeMsinteger

Przykładowa odpowiedź

{
  "attemptsLog": [
    {
      "attempt": 36,
      "error": "<error>",
      "latencyMs": 17,
      "statusCode": 200,
      "success": true
    }
  ],
  "delivered": true,
  "finalStatusCode": 200,
  "responseBody": {},
  "signatureAttached": true,
  "signatureHeaderName": "Ada Lovelace",
  "status": "success",
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 2,
  "totalAttempts": 3,
  "totalExecutionTimeMs": 3
}

Błędy

Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.

400Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
401Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
402Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
404Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
429Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
5xxUsługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane.

Kod

curl -X POST 'https://app.castomapi.com/v1/proxy/webhook-relay' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"customHeaders": {}, "maxRetries": 3, "payload": {}, "secret": "<secret>", "signatureEncoding": "hex", "signatureHeader": "X-Signature-SHA256", "targetUrl": "https://example.com/page", "timeout": 5000}'
const res = await fetch('https://app.castomapi.com/v1/proxy/webhook-relay', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"customHeaders": {}, "maxRetries": 3, "payload": {}, "secret": "<secret>", "signatureEncoding": "hex", "signatureHeader": "X-Signature-SHA256", "targetUrl": "https://example.com/page", "timeout": 5000})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/proxy/webhook-relay', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"customHeaders": {}, "maxRetries": 3, "payload": {}, "secret": "<secret>", "signatureEncoding": "hex", "signatureHeader": "X-Signature-SHA256", "targetUrl": "https://example.com/page", "timeout": 5000})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/proxy/webhook-relay',
    headers={'x-api-key': '<your-api-key>'},
    json={"customHeaders": {}, "maxRetries": 3, "payload": {}, "secret": "<secret>", "signatureEncoding": "hex", "signatureHeader": "X-Signature-SHA256", "targetUrl": "https://example.com/page", "timeout": 5000},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/proxy/webhook-relay');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['customHeaders' => [], 'maxRetries' => 3, 'payload' => [], 'secret' => '<secret>', 'signatureEncoding' => 'hex', 'signatureHeader' => 'X-Signature-SHA256', 'targetUrl' => 'https://example.com/page', 'timeout' => 5000]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja kosztuje 2 tokenów. Nieudane wywołanie nigdy nie jest rozliczane. Każde konto dostaje 1000 darmowych tokenów miesięcznie; opłacone saldo nie wygasa.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Bezpieczny Webhook Relay Proxy z generowaniem podpisu HMAC SHA-256?

2 tokenów za udane wywołanie, pobierane z portfela po odpowiedzi. Nieudane wywołania są bezpłatne. Każde konto dostaje 1000 darmowych tokenów miesięcznie.

Jak się uwierzytelnić?

Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.

Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?

Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.

Jakie są limity?

10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.

OpenAPI: https://app.castomapi.com/docs/json