castomAPI
Odbierz klucz
GET /v1/woocommerce/customers 1 token Klucz API WooCommerce

Jedna strona klientów połączonego sklepu (konta z wbudowaną rolą…

Jedna strona klientów połączonego sklepu (konta z wbudowaną rolą personelu. administrator, shop_manager, editor, author, contributor. nigdy nie są wypisywane).

GET

Żądanie

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

Ta operacja tylko odczytuje. Zmień wartości w ścieżce powyżej i wyślij.

Odpowiedź

{
  "customers": [
    {}
  ],
  "pagination": {
    "hasMore": true,
    "page": 1,
    "perPage": 25,
    "total": 3,
    "totalPages": 3
  },
  "status": "success",
  "storeUrl": "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

Jedna strona klientów połączonego sklepu (konta z wbudowaną rolą personelu. administrator, shop_manager, editor, author, contributor. nigdy nie są wypisywane).

Żądanie

Parametry

PoleWTypWymaganeOpis
storequerystringnieWhich connected store, when several are connected
pagequeryintegerniePage number, 1-based
per_pagequeryintegernieItems per page, 1 to 100
searchquerystringnie
emailquerystringnie
rolequerystringnieA customer role; staff roles and "all" are refused
orderbyqueryenumnie
orderqueryenumnie

Odpowiedź

PoleTypOpis
customersarray<object>
paginationobject
  ↳ hasMoreboolean
  ↳ pageinteger
  ↳ perPageinteger
  ↳ totalinteger
  ↳ totalPagesinteger
statusstring
storeUrlstring
tokensDeductedinteger

Przykładowa odpowiedź

{
  "customers": [
    {}
  ],
  "pagination": {
    "hasMore": true,
    "page": 1,
    "perPage": 25,
    "total": 3,
    "totalPages": 3
  },
  "status": "success",
  "storeUrl": "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 GET 'https://app.castomapi.com/v1/woocommerce/customers' \
  -H 'x-api-key: <your-api-key>'
const res = await fetch('https://app.castomapi.com/v1/woocommerce/customers', {
  method: 'GET',
  headers: { 'x-api-key': '<your-api-key>' }
});
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/woocommerce/customers', {
  method: 'GET',
  headers: { 'x-api-key': '<your-api-key>' }
});
const data = await res.json();
console.log(data);
import requests

res = requests.get(
    'https://app.castomapi.com/v1/woocommerce/customers',
    headers={'x-api-key': '<your-api-key>'},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/woocommerce/customers');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
]);
$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 Jedna strona klientów połączonego sklepu (konta z wbudowaną rolą…?

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