Address Validation API
Bevezetés
A Címellenőrzési API egy intelligens megoldás a pontatlan elérhetőségi adatok javítására és a csomagok gyorsabb és pontosabb kézbesítésére. Ez az API megfelelően formázza a megadott címzett címadatait, amelyek nagymértékben hasonlítanak egy érvényes címhez, és egy olyan valós címet jelenít meg, amely valószínűleg a kívánt cím.
Az API megjegyzésekkel is szolgál a megadott cím hiányosságairól vagy a valós cím megjelenítése érdekében a bevitt adatokon végrehajtott változtatásokról. Ezt az API-t használhatja a címzett címadatainak ellenőrzésére és érvényesítésére, mielőtt csomagot küldene.
Megjegyzés: Ne használja ezt az API-t annak meghatározására, hogy egy adott címre lehet-e kézbesíteni. A FedEx nem kínál kézbesítési szolgáltatást minden érvényes címre. A FedEx nem kézbesít postafiókokba, kivéve a FedEx Ground® Economy, (korábbi nevén FedEx SmartPost®) szolgáltatáson keresztül).
A Címellenőrzési API részletes adatai
Ez az API lehetővé teszi a címzett címadatainak ellenőrzését és érvényesítését a csomag küldése előtt. A pontos címek feltüntetése a fuvarlevél-címkén segít elkerülni a szállítási késedelmeket és a további címhelyesbítési díjakat (a hibás címek miatt).
Megjegyzés:
- A címérvényesítési eredmények országonként/területenként eltérőek.
- A kérelemben megadott címet az API összehasonlítja a FedEx adatbázisában található referenciaadatokkal, és a megfelelő címet visszaküldi.
A Címellenőrzési API funkciói
- Utcaszintű címegyezéseket biztosít.
- Havonta frissíti címadatbázisát.
- Megkülönbözteti az üzleti és a lakossági címeket, ha pontos egyezést talál.
- Jelenleg nem ellenőrzi a ház- vagy lakásszámokat.
A Címellenőrzési API képességei
- Kiegészíti a hiányos címzettcímeket. Bizonyos esetekben a Címellenőrzési API képes a hiányzó információk hozzáadására, attól függően, hogy a megadott információkat a referenciaadatokkal összevetve ellenőrzi-e. A Címellenőrzési API jelenleg nem tudja hozzáadni a hiányzó másodlagos információkat (pl. lakás vagy ház).
- Havonta frissíti címadatbázisát.
- Kijavítja az érvénytelen címzettcímeket. Például javítja a helytelen postai irányítószámot, hogy az megegyezzen a többi bevitt adattal.
- Meghatározza, hogy egy cím üzleti vagy lakossági cím-e, hogy növelje az közelítő árajánlatok pontosságát. Csak amerikai és kanadai címekre vonatkozik.
- Ellenőrzi a címek érvényességét és teljességét a következő régiók számos országában: Kanada, Latin-Amerika, Európa, a Közel-Kelet és az ázsiai és csendes-óceáni térség. A belföldi és nemzetközi címadatokat mostantól a csomag feladása előtt ellenőrizheti, így elkerülheti a felesleges szállítási késedelmeket és a további szolgáltatási díjakat.
- Utcaszintű egyezéseket biztosít.
- Egyetlen API-kérelemmel akár 100 cím ellenőrizhető.
Országok/területek, amelyek támogatják a Címellenőrzési API-t
A FedEx Címellenőrzési API-ját a következő országokban használhatja a címzettek címének ellenőrzésére és javítására a hatékony kézbesítés érdekében:
Antillák | Dánia | Panama |
Argentína | Dominikai Köztársaság | Peru |
Aruba | Észtország | Portugália |
Ausztrália | Finnország | Szingapúr |
Ausztria | Franciaország | Dél-Afrika |
Bahama-szigetek | Németország | Spanyolország |
Barbados | Görögország | Svédország |
Belgium | Guatemala | Svájc |
Bermuda | Hongkong (k.k.t.), Kína | Trinidad és Tobago |
Brazília | Olaszország | Egyesült Királyság |
Kanada | Jamaica | Amerikai Egyesült Államok |
Kajmán-szigetek | Malajzia | Uruguay |
Chile | Mexikó | Venezuela |
Kolumbia | Hollandia | Virgin-szigetek |
Costa Rica | Új-Zéland | |
Csehország | Norvégia |
Megjegyzés: A címellenőrzési kérelemre válaszként visszaküldött információk csak javaslatnak számítanak a felhasználásra vonatkozóan.
Jogi nyilatkozat: Az itt közölt adatok a FedEx tulajdonában lévő és bizalmas információk, amelyeket az Ön kérésére szívességből bocsátunk rendelkezésre. A FedEx írásos engedélye nélkül ezen adatok semmilyen formában nem terjeszthetők vagy adhatók át harmadik félnek. Az adatok a FedEx kézbesítési címadatbázisának aktuális FedEx-címszintű üzleti/lakóhelyi besorolását tükrözik, és változhatnak. A FedEx ezen információk szolgáltatásával nem garantálja azok jelenlegi vagy jövőbeli pontosságát, és nem garantálja, hogy az ezen címekre feladott csomagokat az itt megadott üzleti/lakossági besorolás szerint számlázzák ki. Ezen információk megadása nem jelenti a felek közötti kapcsolat feltételeinek megváltoztatását. A FedEx szállításra és díjakra vonatkozó feltételeit a FedEx Szolgáltatási útmutatójában és bármely kapcsolódó, ügyfélszámlás tarifákra vonatkozó megállapodásban olvashatja el.
Hogyan működik a Címellenőrzési API
Cím ellenőrzése
Ezt a végpontot használhatja a bemeneti címek ellenőrzésére és érvényesítésére, ezáltal pedig valós címek megjelenítésére. A címadatok megadásával és ellenőrzésével érvényesíthető egy cím. Egy cím akkor tekinthető érvényesnek, ha a beírt cím megegyezik az ismert referenciaadatokkal.
A kérelemhez kapcsolódó szükséges bemeneti adatok a következők:
- Utca címsorai
- Város (nem kötelező)
- Állam vagy tartomány kódja (nem kötelező)
- Irányítószám (nem kötelező)
- Országhívószám
Megjegyzés: Az állam kódja vagy a város neve elegendő, ha az ügyfél olyan országba szállít, ahol nincs postai irányítószám.
A Címellenőrzési API a következő műveleteket végzi el a megadott címadatokon egy valós cím megjelenítése érdekében:
- Első lépésként az API megpróbálja normalizálni a beírt címet. Ide tartozhat például a közterület jellegét jelző szavak, mint az „utca“ vagy „autópálya“ szavak kicserélése a szabványos rövidítéseikre (angolul: ST és PKWY), valamint a címelemek sorrendjének megváltoztatása. Ha egy beírt cím nem normalizálható, az érvényesített cím a beírt cím marad. A nem címértékek elvetésre kerülnek.
- A második lépésben az API megpróbálja szabványossá tenni a normalizált címet azáltal, hogy olyan lehetséges vagy tényleges címet talál, amely valószínűleg megfelel a felhasználó által megadni szándékozott címnek. Ha ez a szabványosítás nem sikerül, az érvényesített cím a beírt cím normalizált formája lesz. A válaszban visszaküldött elemek segítségével meghatározhatja, hogy milyen problémák merültek fel a beírt címmel kapcsolatban.
- A normalizált cím bizonyos elemei is megjelennek a válaszban. Ha a szabványosítás sikerül, az érvényesített címek a valós címek lesznek. Ebben az esetben a szabványosított cím különböző további elemei és a normalizált címből való származtatás módjára vonatkozó információk is megjelennek.
A Címellenőrzési API visszaküldési értékei
Ha a válaszban megjelenített cím tartalmazza az alábbi attribútumok következő értékeit, akkor a cím érvényes:
- A cím állama szabványosított
- Az érvényesített cím attribútumai igazak (True)
- A Delivery Point Valid (DPV) érték igaz (True)
- Az interpolált cím értéke hamis (False)
Ha ezek nem szerepelnek a listában, akkor a további attribútumok segítségével határozza meg a címértékekkel kapcsolatos lehetséges problémákat.
A címattribútumokra vonatkozó további tájékoztatásért olvassa el a Címattribútumok című részt.
Ha az ügyfélnek küldött kimeneti üzenet INTERPOLATED.STREET.ADDRESS, akkor lehetséges, hogy a cím nem érvényes. Az ügyfélnek küldött üzenetek kódjával kapcsolatos további információkért olvassa el az ügyfélnek szánt üzenetek elemeinek leírását.
Urbanizáció (csak Puerto Rico): Ez a Puerto Rico városi területein általánosan használt leírás a címformátum fontos része, mivel egy adott utca elhelyezkedését írja le. Puerto Ricóban ugyanazon az irányítószámon belül ismétlődő utcanevek és címszámtartományok találhatók. Ezek az utcák ugyanazokkal a házszámtartományokkal rendelkezhetnek. Ezekben az esetekben az urbanizációs névre van szükség egy adott cím helyének helyes azonosításához.
Példa: Sr Pedro Rivera Urb Hermosillo 123 Calle 1 Bayamon, PR 00961-1212.
Megjegyzések
A Címellenőrzési API minden egyes ellenőrzött és válaszként megjelenített címhez megjegyzéseket fűz. A megjegyzések tájékoztatást adnak a hiányosságokról, ha vannak ilyenek, és a beírt címen végrehajtott változtatásokról, amelyekkel eljutott a valós címhez.
Cím besorolása
A Címellenőrzési API referenciaadatok segítségével határozza meg egy adott cím besorolását. A funkcionális címek besorolását a címellenőrzési folyamattól függetlenül számítják ki, és az operatív személyzet visszajelzésein alapul, emellett pedig kereskedelmi adatforrásokat is használnak, de csupán megerősítésre.
A Címellenőrzési API csak négy lehetséges címosztályozási lehetőséggel rendelkezik: ismeretlen, üzleti, lakossági és vegyes. Minden cím „ismeretlen” besorolással kezdődik, és így is marad, amíg a címellenőrzéssel kapcsolatos üzleti szabályok meg nem határozzák, hogy a címek besorolását meg kell változtatni. Egy helyszín csak akkor kap „vegyes” besorolást, ha több bérlővel rendelkező cím, és üzleti és lakóegységeket egyaránt tartalmaz.
Megjegyzés: A FedEx Express szolgáltatás egy további címsorral (3. címsor) látja el a címzettcímeket. Ez a kiegészítő címadat teljesebb és pontosabb helymeghatározási adatokat biztosít, javítva a pontos cím beszerzésének esélyét.
A valós címek a következőképpen vannak osztályozva:
Üzleti cím
Az üzleti cím az a cím, amelyet az Ön fő telephelyének megjelölésére használnak. Ez az a hely, ahonnan a vállalkozása hivatalosan működik, de ez nem biztos, hogy mindig megfelel a valóságnak.
Az üzleti cím a vállalat telephelyének hivatalos helye. Ez lehet bármi, kezdve valakinek a lakcímétől egészen a több millió dolláros épületegyüttesekig, amelyeket jellemzően a nagy technológiai cégek használnak, és minden, ami a kettő között van.
Lakcím
Lakossági kézbesítési díj vonatkozik az Egyesült Államokon belüli, otthonra vagy magánlakásra irányuló küldeményekre, beleértve azokat a helyeket is, ahol egy üzletet otthonról működtetnek. Lakossági kézbesítéshez használja a FedEx Home Delivery (otthoni kézbesítés) lehetőséget a FedEx Ground szolgáltatáson keresztül, és a rendeltetési helytől mért távolságtól függően 1 munkanapon belül megérkezhet a küldeménye.
Példa:
- Parókia
- Kolostor
- Plébánia
- Többlakásos épületek lakói, mint például:
- Lakóépületek
- Lakóparkok
- Kollégiumok
- Olyan lakóhely, ahol termékeket értékesítenek és/vagy forgalmaznak
A Címellenőrzési API használatával kapcsolatos tippek
A következőkben hasznos tanácsokat mutatunk be a Címellenőrzési API használatára vonatkozóan:
- Használja helyesen a szóközöket: Ügyeljen a szóközök helyes elhelyezésére, és kerülje a felesleges szóközöket.
- Írjon helyesen: Kerülje a helyesírási és tipográfiai hibákat. Győződjön meg arról is, hogy helyesen használja a nullát (0) és az O betűt.
- Kerülje a speciális karaktereket: Kérjük, tartózkodjon a címhez nem szükséges különleges karakterek használatától, például a rövidítések utáni pontoktól (Ave, illetve Ave.).
- Adjon meg további cím- és utcaadatokat: További címadatok megadásával növelheti a címkeresési eredmények pontosságát.
- Épület- vagy házszám – 1, 1A, 1½, One
- Közterület neve – Main, George Washington, 42nd
- Közterület jellege – Road, Avenue, Rd, Ave (út, sugárút, ú., sgt.)
- Adja meg a várost, államot/tartományt és az irányítószámot: Ha mindhármat megadja, az növeli a címkeresési eredmények pontosságát.
- Adja meg az utcát és a címet megfelelő sorrendben: Az utcai címelemek általában az épület- vagy házszámmal kezdődő formátumot követik, amelyet egy iránymutató előtag, egy utcanév, utcatípus vagy -jelleg, egy iránymutató utótag, lakásmegjelölés, lakásszám és/vagy magánpostafiók megjelölése és száma követ.
- Használjon helyes rövidítéseket: A U.S. Postal Service és a Canada Post szabványos rövidítésekkel rendelkezik az állam/tartomány, az utca jellege és a lakás vagy lakóegység megnevezésére vonatkozóan.
- A nem szabványos rövidítés rossz keresési eredményeket eredményezhet.
- Ha bizonytalan egy rövidítéssel kapcsolatban, ne használja azt.
- Urbanizáció - Az urbanizációs elnevezés egy földrajzi területen belüli területet, körzetet vagy lakóövezetet jelöl.
Példák:
- Épület- vagy házszám, mint például 1, 1A, 1½, One
- Közterület neve, mint például Main, George Washington, 42nd.
- Közterület jellege, mint például Road, Avenue, Rd, Ave (út, sugárút, ú., sgt.)
- Adja meg a várost, államot/tartományt és az irányítószámot: Az összes címadat megadása növeli az eredmények pontosságát. A cím ellenőrzéséhez nem szükséges az irányítószám ZIP+4 része.
- Használjon helyes rövidítéseket: A U.S. Postal Service és a postai hatóságok egyéb országokban szabványos rövidítéseket határoznak meg az állam/tartomány, az utca jellege és a lakás vagy lakóegység megnevezésére vonatkozóan. A nem szabványos rövidítés rossz keresési eredményeket eredményezhet. Ha bizonytalan egy rövidítéssel kapcsolatban, ne használja azt.
- Fontolja meg a címellenőrzési válaszban található visszajelzés továbbítását a felhasználónak, hogy lehetőséget adjon neki a számára legmegfelelőbb cím kiválasztására.
Üzleti szabályok
- Ne használja ezt az API-t annak meghatározására, hogy egy adott címre lehet-e kézbesíteni. A FedEx nem kínál kézbesítési szolgáltatást minden érvényes címre. A FedEx nem kézbesít postafiókokba (kivéve a FedEx Ground® Economy, korábbi nevén FedEx SmartPost® szolgáltatáson keresztül).
- Az érvényesített címhez kapcsolódó visszaküldött információk csak javaslatnak számítanak a felhasználásra vonatkozóan
- Egyetlen kérelemmel akár 100 cím ellenőrizhető.
- A kötelezően kitöltendő mezők száma országonként eltérő.
Például az amerikai címek esetében legalább egy címsor és vagy egy postai irányítószám, vagy egy város és egy államkód szükséges, de az AUS-címek (ausztrál címformátum) esetében az államkód elhagyható postai irányítószám nélkül is.
- A címérvényesítési eredmény országonként/területenként eltérő lehet.
Megjegyzés: A Címellenőrzési API nem minden országban alkalmazható. Olvassa el A Címellenőrzési API-t támogató országok/területek című szakaszt.
JSON API-gyűjtemény
Address Validation APi (1.0.0)
Validate Address
Use this endpointtt to get address resolution details. These details areee the outcome of validation and resolution of the input address. An address is stated as resolved when the input address matches the known reference data.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- Full_Schema_Validate_Address
- Address_Validation_Canada
- Address_Validation_US
- Address_Validation_for_Germany
- Address_Validation_for_Italy
- Address_Validation_for_UK
inEffectAsOfTimestamp | string This can be used to request the characteristics of an address had at a particular time in history. This defaults to current date time (of the Address Validation System). This is useful because the AddressValidation database is dynamic and stores historical data. Characteristics such as Business/Residential indicator may change over time. |
validateAddressControlParameters | object (AddressResolutionControlParameters) Specify the parameters applied to validate the address. |
addressesToValidate required | Array of objects (ResolveContactAndAddress) Indicate the address to be validated and resolved. This includes the address details, such as streetline, state or province code, country code and postal code. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "inEffectAsOfTimestamp": "2019-09-06",
- "validateAddressControlParameters": {
- "includeResolutionTokens": true
- "addressesToValidate": [
- {
- "address": {
- "streetLines": [
- "7372 PARKRIDGE BLVD",
- "APT 286",
- "2903 sprank"
- "city": "IRVING",
- "stateOrProvinceCode": "TX",
- "postalCode": "75063-8659",
- "countryCode": "US"
- "clientReferenceId": "None"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "XXX_ORDERXXXX789",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "resolvedAddresses": [
- {
- "streetLinesToken": [
- "7372 PARKRIDGE BLVD",
- "APT 286"
- "city": "IRVING",
- "stateOrProvinceCode": "TX",
- "countryCode": "US",
- "customerMessage": [
- null
- "cityToken": [
- "TOK-1X3256"
- "postalCodeToken": {
- "changed": false,
- "value": "SAN JUAN"
- "parsedPostalCode": {
- "base": "00926",
- "addOn": "2716",
- "deliveryPoint": "50"
- "classification": "BUSINESS",
- "postOfficeBox": true,
- "normalizedStatusNameDPV": true,
- "standardizedStatusNameMatchSource": "Postal",
- "resolutionMethodName": "USPS_VALIDATE",
- "ruralRouteHighwayContract": false,
- "generalDelivery": false,
- "attributes": {
- "POBox": false,
- "POBoxOnlyZIP": false,
- "SplitZip": false,
- "SuiteRequiredButMissing": false,
- "InvalidSuiteNumber": false,
- "ResolutionInput": "RAW_ADDRESS",
- "DPV": false,
- "ResolutionMethod": "GENERIC_VALIDATE",
- "DataVintage": "July 2020",
- "MatchSource": "Postal",
- "CountrySupported": true,
- "ValidlyFormed": true,
- "Matched": true,
- "Resolved": true,
- "Inserted": false,
- "MultiUnitBase": false,
- "ZIP11Match": false,
- "ZIP4Match": false,
- "UniqueZIP": false,
- "StreetAddress": false,
- "RRConversion": false,
- "ValidMultiUnit": false,
- "AddressType": "STANDARDIZED",
- "AddressPrecision": "MULTI_TENANT_UNIT",
- "MultipleMatches": false
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "message": "Recipient Postal-City Mismatch.",
- "alertType": "NOTE"
Response