castomAPI
Odbierz klucz
POST /v1/salesforce/composite od 1 token Klucz API Salesforce

Wykonuje do 25 podżądań Salesforce REST jako jedno wywołanie

Wykonuje do 25 podżądań Salesforce REST jako jedno wywołanie. opcjonalnie transakcyjne (allOrNone) i łańcuchowalne (@{referenceId.field}). Salesforce liczy całe wywołanie jako JEDNO żądanie w codziennym limicie orga. Własny sublimit Salesforce — co…

POST

Żądanie

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

Odpowiedź 

{
  "results": [],
  "status": "success",
  "summary": {
    "failed": 34,
    "succeeded": 25,
    "total": 3
  },
  "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

Wykonuje do 25 podżądań Salesforce REST jako jedno wywołanie. opcjonalnie transakcyjne (allOrNone) i łańcuchowalne (@{referenceId.field}). Salesforce liczy całe wywołanie jako JEDNO żądanie w codziennym limicie orga. Własny sublimit Salesforce — co najwyżej 5 podżądań query/kolekcji sObject na wywołanie — NIE jest tutaj egzekwowany. wymagałoby to od nas parsowania każdego url, by odgadywać jego rodzaj, a własna odmowa Salesforce nazywa tę zasadę lepiej niż jakiekolwiek zgadywanie. Zewnętrzny status HTTP to zawsze 200: sprawdź httpStatusCode każdego wyniku. pomyślne podżądania, minimum 1

Żądanie

Treść

PoleTypWymaganeOpis
accountIdstringnie
allOrNonebooleannieRoll the whole set back if any subrequest fails (Salesforce default: false)
collateSubrequestsbooleannie
compositeRequestarray<object>tak
  ↳ bodyobjectnie
  ↳ httpHeadersobjectniePer-subrequest headers (If-Match, Sforce-Auto-Assign, ...). Authorization is rejected -- subrequests inherit the connection's own token
  ↳ methodenumtakOne of: GET, POST, PUT, PATCH, DELETE, HEAD.
  ↳ referenceIdstringtakReferenced by sibling subrequests as @{thisId.Field}
  ↳ urlstringtakFull relative REST path, e.g. /services/data/v67.0/sobjects/Account/ -- note this endpoint wants the /services/data prefix and /composite/batch does not

Przykładowe żądanie

{
  "accountId": "acc_144960",
  "allOrNone": true,
  "collateSubrequests": true,
  "compositeRequest": [
    {
      "body": {},
      "httpHeaders": {
        "key": "example"
      },
      "method": "GET",
      "referenceId": "ref_600177",
      "url": "https://example.com/page"
    }
  ]
}

Odpowiedź

PoleTypOpis
resultsarray<object>
statusstring
summaryobject
  ↳ failedinteger
  ↳ succeededinteger
  ↳ totalinteger
tokensDeductedinteger

Przykładowa odpowiedź

{
  "results": [],
  "status": "success",
  "summary": {
    "failed": 34,
    "succeeded": 25,
    "total": 3
  },
  "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/salesforce/composite' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"accountId": "acc_144960", "allOrNone": true, "collateSubrequests": true, "compositeRequest": [{"body": {}, "httpHeaders": {"key": "example"}, "method": "GET", "referenceId": "ref_600177", "url": "https://example.com/page"}]}'
const res = await fetch('https://app.castomapi.com/v1/salesforce/composite', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"accountId": "acc_144960", "allOrNone": true, "collateSubrequests": true, "compositeRequest": [{"body": {}, "httpHeaders": {"key": "example"}, "method": "GET", "referenceId": "ref_600177", "url": "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/salesforce/composite', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"accountId": "acc_144960", "allOrNone": true, "collateSubrequests": true, "compositeRequest": [{"body": {}, "httpHeaders": {"key": "example"}, "method": "GET", "referenceId": "ref_600177", "url": "https://example.com/page"}]})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/salesforce/composite',
    headers={'x-api-key': '<your-api-key>'},
    json={"accountId": "acc_144960", "allOrNone": True, "collateSubrequests": True, "compositeRequest": [{"body": {}, "httpHeaders": {"key": "example"}, "method": "GET", "referenceId": "ref_600177", "url": "https://example.com/page"}]},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/salesforce/composite');
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(['accountId' => 'acc_144960', 'allOrNone' => true, 'collateSubrequests' => true, 'compositeRequest' => [['body' => [], 'httpHeaders' => ['key' => 'example'], 'method' => 'GET', 'referenceId' => 'ref_600177', 'url' => 'https://example.com/page']]]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja kosztuje od 1 token. Nieudane wywołanie nigdy nie jest rozliczane. Każde konto dostaje 1000 darmowych tokenów miesięcznie; opłacone saldo nie wygasa. 1 token za każdą faktycznie udaną operację, minimum 1.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Wykonuje do 25 podżądań Salesforce REST jako jedno wywołanie?

od 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. 1 token za każdą faktycznie udaną operację, minimum 1.

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