castomAPI
Odbierz klucz
POST /v1/zapier/handshake 1 token Klucz API Zapier

Wykonaj sprawdzenia uwierzytelniania Zapiera

Wykonaj sprawdzenia uwierzytelniania Zapiera, challenge weryfikacyjne lub handshakes subskrypcji REST Hook

POST

Żądanie

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

Odpowiedź 

{
  "account": {
    "balance": 7.3,
    "email": "ada@example.com",
    "userId": "use_616343"
  },
  "challenge": "<challenge>",
  "handshakeId": "han_475353",
  "serverTime": "10:00",
  "signature": "t=1725782400,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd",
  "status": "success",
  "tokensDeducted": 1,
  "verified": true
}
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

Wykonaj sprawdzenia uwierzytelniania Zapiera, challenge weryfikacyjne lub handshakes subskrypcji REST Hook

Żądanie

Treść

PoleTypWymaganeOpis
challengestringnieVerification challenge string provided by Zapier during hook subscription setup
eventstringnieHook event type to handshake
subscriptionIdstringnieZapier subscription identifier
targetUrlstringnieZapier REST Hook target endpoint

Przykładowe żądanie

{
  "challenge": "<challenge>",
  "event": "ping",
  "subscriptionId": "sub_123030",
  "targetUrl": "https://example.com/page"
}

Odpowiedź

PoleTypOpis
accountobject
  ↳ balancenumber
  ↳ emailstring
  ↳ userIdstring
challengestring
handshakeIdstring
serverTimestring
signaturestring
statusstring
tokensDeductedinteger
verifiedboolean

Przykładowa odpowiedź

{
  "account": {
    "balance": 7.3,
    "email": "ada@example.com",
    "userId": "use_616343"
  },
  "challenge": "<challenge>",
  "handshakeId": "han_475353",
  "serverTime": "10:00",
  "signature": "t=1725782400,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd",
  "status": "success",
  "tokensDeducted": 1,
  "verified": true
}

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/zapier/handshake' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"challenge": "<challenge>", "event": "ping", "subscriptionId": "sub_123030", "targetUrl": "https://example.com/page"}'
const res = await fetch('https://app.castomapi.com/v1/zapier/handshake', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"challenge": "<challenge>", "event": "ping", "subscriptionId": "sub_123030", "targetUrl": "https://example.com/page"})
});
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/zapier/handshake', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"challenge": "<challenge>", "event": "ping", "subscriptionId": "sub_123030", "targetUrl": "https://example.com/page"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/zapier/handshake',
    headers={'x-api-key': '<your-api-key>'},
    json={"challenge": "<challenge>", "event": "ping", "subscriptionId": "sub_123030", "targetUrl": "https://example.com/page"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/zapier/handshake');
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(['challenge' => '<challenge>', 'event' => 'ping', 'subscriptionId' => 'sub_123030', 'targetUrl' => 'https://example.com/page']),
]);
$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 Wykonaj sprawdzenia uwierzytelniania Zapiera?

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