castomAPI
Odbierz klucz
POST /v1/verify/address bezpłatny Bez klucza Weryfikacja

Parsuj, standaryzuj (USPS Pub 28 / CASS) i oceniaj dostarczalność…

Parsuj, standaryzuj (USPS Pub 28 / CASS) i oceniaj dostarczalność międzynarodowych adresów pocztowych

POST

Żądanie

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

Odpowiedź 

{
  "deliverabilityCode": "DELIVERABLE",
  "deliverabilityScore": 0,
  "standardizedAddress": {
    "addressLine1": "Powstańców Śląskich 5/212, 53-332 Wrocław",
    "addressLine2": "Powstańców Śląskich 5/212, 53-332 Wrocław",
    "city": "Wrocław",
    "countryCode": "PL",
    "countryName": "Poland",
    "postalCode": "53-332",
    "singleLineFormatted": "PL61 1090 1014 0000 0712 1981 2874",
    "state": "<state>"
  },
  "status": "success",
  "tokensDeducted": 1,
  "validationResult": {
    "isPostalCodeValid": true,
    "missingFields": [
      "<missing field>"
    ],
    "postalCodeFormat": "json",
    "warnings": []
  }
}
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

Parsuj, standaryzuj (USPS Pub 28 / CASS) i oceniaj dostarczalność międzynarodowych adresów pocztowych

Żądanie

Treść

PoleTypWymaganeOpis
addressLine1stringniePrimary street address line
addressLine2stringnieSecondary address line (Apt, Suite, Unit, etc.)
citystringnieCity, town, or municipality
countryCodestringnieISO 3166-1 Alpha-2 country code (default: US)
postalCodestringniePostal or ZIP code
rawAddressstringnieOptional single-line address string to auto-parse if structured fields are omitted
statestringnieState, province, or region

Przykładowe żądanie

{
  "addressLine1": "Powstańców Śląskich 5/212, 53-332 Wrocław",
  "addressLine2": "Powstańców Śląskich 5/212, 53-332 Wrocław",
  "city": "Wrocław",
  "countryCode": "US",
  "postalCode": "53-332",
  "rawAddress": "Powstańców Śląskich 5/212, 53-332 Wrocław",
  "state": "<state>"
}

Odpowiedź

PoleTypOpis
deliverabilityCodeenumOne of: DELIVERABLE, PARTIALLY_DELIVERABLE, UNDELIVERABLE.
deliverabilityScoreinteger
standardizedAddressobject
  ↳ addressLine1string
  ↳ addressLine2string
  ↳ citystring
  ↳ countryCodestring
  ↳ countryNamestring
  ↳ postalCodestring
  ↳ singleLineFormattedstring
  ↳ statestring
statusstring
tokensDeductedinteger
validationResultobject
  ↳ isPostalCodeValidboolean
  ↳ missingFieldsarray<string>
  ↳ postalCodeFormatstring
  ↳ warningsarray<string>

Przykładowa odpowiedź

{
  "deliverabilityCode": "DELIVERABLE",
  "deliverabilityScore": 0,
  "standardizedAddress": {
    "addressLine1": "Powstańców Śląskich 5/212, 53-332 Wrocław",
    "addressLine2": "Powstańców Śląskich 5/212, 53-332 Wrocław",
    "city": "Wrocław",
    "countryCode": "PL",
    "countryName": "Poland",
    "postalCode": "53-332",
    "singleLineFormatted": "PL61 1090 1014 0000 0712 1981 2874",
    "state": "<state>"
  },
  "status": "success",
  "tokensDeducted": 1,
  "validationResult": {
    "isPostalCodeValid": true,
    "missingFields": [
      "<missing field>"
    ],
    "postalCodeFormat": "json",
    "warnings": []
  }
}

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/verify/address' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"addressLine1": "Powstańców Śląskich 5/212, 53-332 Wrocław", "addressLine2": "Powstańców Śląskich 5/212, 53-332 Wrocław", "city": "Wrocław", "countryCode": "US", "postalCode": "53-332", "rawAddress": "Powstańców Śląskich 5/212, 53-332 Wrocław", "state": "<state>"}'
const res = await fetch('https://app.castomapi.com/v1/verify/address', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"addressLine1": "Powstańców Śląskich 5/212, 53-332 Wrocław", "addressLine2": "Powstańców Śląskich 5/212, 53-332 Wrocław", "city": "Wrocław", "countryCode": "US", "postalCode": "53-332", "rawAddress": "Powstańców Śląskich 5/212, 53-332 Wrocław", "state": "<state>"})
});
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/verify/address', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"addressLine1": "Powstańców Śląskich 5/212, 53-332 Wrocław", "addressLine2": "Powstańców Śląskich 5/212, 53-332 Wrocław", "city": "Wrocław", "countryCode": "US", "postalCode": "53-332", "rawAddress": "Powstańców Śląskich 5/212, 53-332 Wrocław", "state": "<state>"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/verify/address',
    headers={'x-api-key': '<your-api-key>'},
    json={"addressLine1": "Powstańców Śląskich 5/212, 53-332 Wrocław", "addressLine2": "Powstańców Śląskich 5/212, 53-332 Wrocław", "city": "Wrocław", "countryCode": "US", "postalCode": "53-332", "rawAddress": "Powstańców Śląskich 5/212, 53-332 Wrocław", "state": "<state>"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/verify/address');
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(['addressLine1' => 'Powstańców Śląskich 5/212, 53-332 Wrocław', 'addressLine2' => 'Powstańców Śląskich 5/212, 53-332 Wrocław', 'city' => 'Wrocław', 'countryCode' => 'US', 'postalCode' => '53-332', 'rawAddress' => 'Powstańców Śląskich 5/212, 53-332 Wrocław', 'state' => '<state>']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Koszt i limity

Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.

Limity żądań na minutę

Bez klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

Pytania

Ile kosztuje Parsuj, standaryzuj (USPS Pub 28 / CASS) i oceniaj dostarczalność…?

Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.

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