castomAPI
Odbierz klucz
POST /v1/proxy/cache-accelerator 1 token Klucz API Proxy

Przyspiesza endpointy zewnętrznych API za pomocą warstwy cache Redis na…

Przyspiesza endpointy zewnętrznych API za pomocą warstwy cache Redis na edge z własnym TTL i metrykami trafień

POST

Żądanie

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

Odpowiedź 

{
  "cache": {
    "cacheKey": "example",
    "cachedAt": "<cached at>",
    "hit": true,
    "ttlRemainingSeconds": 3600,
    "ttlSeconds": 3600
  },
  "contentType": "application/pdf",
  "data": {},
  "executionTimeMs": 6,
  "headers": {
    "key": "example"
  },
  "status": "success",
  "statusCode": 200,
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 1
}
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

Przyspiesza endpointy zewnętrznych API za pomocą warstwy cache Redis na edge z własnym TTL i metrykami trafień

Żądanie

Treść

PoleTypWymaganeOpis
bodystring | objectnieOptional payload for POST/PUT/PATCH requests
forceRefreshbooleannieForce a cache miss and re-fetch fresh data from the target upstream server
headersobjectnie
methodenumnieOne of: GET, POST, PUT, DELETE, PATCH.
targetUrlstringtak
timeoutintegernie
ttlSecondsintegernieTime-To-Live in seconds for cached response (Default: 300s / 5m, Max: 86400s / 24h)
varyHeadersarray<string>nieList of request header names to include in cache key generation (e.g., ["Authorization", "Accept-Language"])

Przykładowe żądanie

{
  "body": "Hello from castomAPI.",
  "forceRefresh": false,
  "headers": {},
  "method": "GET",
  "targetUrl": "https://example.com/page",
  "timeout": 10000,
  "ttlSeconds": 300,
  "varyHeaders": []
}

Odpowiedź

PoleTypOpis
cacheobject
  ↳ cacheKeystring
  ↳ cachedAtstring
  ↳ hitboolean
  ↳ ttlRemainingSecondsinteger
  ↳ ttlSecondsinteger
contentTypestring
dataobject | array | string
executionTimeMsinteger
headersobject
statusstring
statusCodeinteger
targetUrlstring
tokensDeductedinteger

Przykładowa odpowiedź

{
  "cache": {
    "cacheKey": "example",
    "cachedAt": "<cached at>",
    "hit": true,
    "ttlRemainingSeconds": 3600,
    "ttlSeconds": 3600
  },
  "contentType": "application/pdf",
  "data": {},
  "executionTimeMs": 6,
  "headers": {
    "key": "example"
  },
  "status": "success",
  "statusCode": 200,
  "targetUrl": "https://example.com/page",
  "tokensDeducted": 1
}

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/cache-accelerator' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"body": "Hello from castomAPI.", "forceRefresh": false, "headers": {}, "method": "GET", "targetUrl": "https://example.com/page", "timeout": 10000, "ttlSeconds": 300, "varyHeaders": []}'
const res = await fetch('https://app.castomapi.com/v1/proxy/cache-accelerator', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"body": "Hello from castomAPI.", "forceRefresh": false, "headers": {}, "method": "GET", "targetUrl": "https://example.com/page", "timeout": 10000, "ttlSeconds": 300, "varyHeaders": []})
});
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/cache-accelerator', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"body": "Hello from castomAPI.", "forceRefresh": false, "headers": {}, "method": "GET", "targetUrl": "https://example.com/page", "timeout": 10000, "ttlSeconds": 300, "varyHeaders": []})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/proxy/cache-accelerator',
    headers={'x-api-key': '<your-api-key>'},
    json={"body": "Hello from castomAPI.", "forceRefresh": False, "headers": {}, "method": "GET", "targetUrl": "https://example.com/page", "timeout": 10000, "ttlSeconds": 300, "varyHeaders": []},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/proxy/cache-accelerator');
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(['body' => 'Hello from castomAPI.', 'forceRefresh' => false, 'headers' => [], 'method' => 'GET', 'targetUrl' => 'https://example.com/page', 'timeout' => 10000, 'ttlSeconds' => 300, 'varyHeaders' => []]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja kosztuje 1 token. 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 Przyspiesza endpointy zewnętrznych API za pomocą warstwy cache Redis na…?

1 token 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