Wprowadzenie
Interfejs API weryfikacji adresu to inteligentne rozwiązanie umożliwiające rozpoznawanie niedokładnych danych kontaktowych oraz szybsze i precyzyjne doręczanie paczek. Odpowiednio formatuje on wejściowe informacje adresowe odbiorcy, które przypominają poprawny adres, i zwraca rzeczywisty adres, którego prawdopodobnie zamierzał użyć wysyłający.
Ten interfejs API udostępnia także adnotacje dotyczące wad adresu wejściowego lub zmian wprowadzonych w danych wejściowych w celu uzyskania rzeczywistego adresu. Przy jego użyciu możesz weryfikować i rozpoznawać informacje adresowe odbiorcy przed wysłaniem paczki.
Uwaga: Tego interfejsu API nie należy używać do określania możliwości doręczenia na dany adres. FedEx nie oferuje usługi doręczania na każdy poprawny adres. FedEx nie wykonuje doręczeń do skrytek pocztowych, z wyjątkiem przesyłek FedEx Ground® Economy (wcześniej występujących pod nazwą FedEx SmartPost®).
Szczegóły interfejsu API Address Validation
Ten interfejs API umożliwia weryfikację i poprawianie informacji adresowych odbiorcy przed wysłaniem paczki. Dokładne adresy na etykiecie wysyłkowej pomagają wyeliminować opóźnienia doręczenia oraz dodatkowe opłaty związane z poprawieniem błędnego adresu.
Uwaga:
- Rezultaty rozpoznawania adresu różnią się zależnie od kraju/terytorium.
- Adres wprowadzony w żądaniu jest porównywany z danymi referencyjnymi w bazie danych FedEx, a następnie zwracany jest dopasowany adres.
Funkcje interfejsu API weryfikacji adresu
- Dopasowanie adresu na poziomie ulicy.
- Comiesięczne aktualizacje bazy danych adresów.
- Rozróżnianie między adresami firmowymi i domowymi w przypadku znalezienia dokładnego dopasowania.
- Obecnie nie ma możliwości weryfikowania numerów lokali czy mieszkań.
Możliwości interfejsu API weryfikacji adresu
- Uzupełnianie niepełnych adresów odbiorców. W niektórych przypadkach interfejs API weryfikacji adresu umożliwia dodanie brakujących informacji zależnie od weryfikacji podanych informacji przy użyciu danych referencyjnych. Ten interfejs API nie umożliwia obecnie dodawania brakujących dodatkowych informacji (na przykład dotyczących lokalu lub mieszkania).
- Comiesięczne aktualizacje bazy danych adresów.
- Poprawianie niepoprawnych adresów odbiorców. Na przykład poprawienie niepoprawnego kodu pocztowego w celu jego dopasowania do pozostałych informacji wejściowych.
- Określanie, czy adres to adres firmowy, czy domowy w celu zwiększenia dokładności specjalnych ofert cenowych. Dotyczy tylko adresów w Stanach Zjednoczonych i Kanadzie.
- Potwierdzenie poprawności i kompletności adresów w wielu krajach/obszarach w tych regionach: Stany Zjednoczone, Kanada, Ameryka Łacińska, Europa, Bliski Wschód oraz Azja i Pacyfik. Teraz możesz weryfikować krajowe i międzynarodowe informacje adresowe przed wysłaniem paczki, eliminując opóźnienia doręczenia oraz dodatkowe opłaty za usługę.
- Dopasowania na poziomie ulicy.
- Jedno żądanie API umożliwia sprawdzenie do 100 adresów.
Kraje/terytoria, w których obsługiwany jest interfejs API weryfikacji adresu
Interfejsu API weryfikacji adresu FedEx możesz używać w poniższych krajach do weryfikacji i poprawiania adresu odbiorcy na potrzeby skutecznego doręczania.
Holenderskie | Dania | Panama |
Argentyna | Dominikana | Peru |
Aruba | Estonia | Portugalia |
Australia | Finlandia | Singapur |
Austria | Francja | Republika Południowej Afryki |
Bahamy | Niemcy | Hiszpania |
Barbados | Grecja | Szwecja |
Belgia | Gwatemala | Szwajcaria |
Bermudy | Specjalny Region Administracyjny Hongkong, Chiny | Trinidad i Tobago |
Brazylia | Włochy | Wielka Brytania |
Kanada | Jamajka | Stany Zjednoczone |
Kajmany | Malezja | Urugwaj |
Chile | Meksyk | Wenezuela |
Kolumbia | Holandia | Wyspy Dziewicze |
Kostaryka | Nowa Zelandia | |
Czechy | Norwegia |
Uwaga: informacje zwracane przez żądanie weryfikacji adresu mają tylko charakter podpowiedzi.
Zastrzeżenia prawne: dane podane w niniejszym dokumencie stanowią poufną własność intelektualną FedEx udostępnianą na prośbę na zasadzie grzecznościowej. Żadna część z tych danych nie może być rozpowszechniana ani w jakiejkolwiek postaci ujawniana podmiotom trzecim bez pisemnej zgody FedEx. Odzwierciedlają one bieżącą klasyfikację adresów firmowych/domowych w bazie danych adresów doręczenia FedEx i mogą zostać zmienione. Udostępniając niniejsze informacje, FedEx nie gwarantuje ich obecnej lub przyszłej dokładności ani nie gwarantuje, że paczki wysłane na udostępnione adresy będą miały faktury sporządzone na podstawie udostępnionej klasyfikacji adresów firmowych/domowych. Udostępnienie niniejszych informacji nie zmienia warunków współpracy stron. Więcej informacji zawiera dokument FedEx Service Guide (Przewodnik po usługach FedEx) oraz wszelkie mające zastosowanie i dotyczące konta warunki umów cenowych dotyczących wysyłki i opłat FedEx.
Jak działa interfejs API Address Validation
Weryfikacja adresu
Ten punkt końcowy służy do weryfikacji i rozpoznawania adresów wejściowych i zwracania rzeczywistych adresów. Szczegóły adresu są podawane i weryfikowane w celu rozpoznania adresu. Adres jest uznany za rozpoznany, gdy adres wejściowy odpowiada znanym danym referencyjnym.
Wymagane informacje wejściowe związane z tym żądaniem to:
- Wiersze adresu
- Miasto (opcjonalne)
- Kod stanu lub prowincji (opcjonalnie)
- Kod pocztowy (opcjonalnie)
- Kod kraju
Uwaga: kod stanu lub nazwa miasta wystarczy, gdy klient wysyła przesyłkę do kraju bez kodu pocztowego.
Interfejs API weryfikacji adresu zwraca rzeczywisty adres, wykonując poniższe operacje na adresie wejściowym:
- Najpierw interfejs API podejmuje próbę normalizacji adresu wejściowego. Może to obejmować zastąpienie częstych identyfikatorów dróg, na przykład informacji o ulicy lub alei, ich standardowymi skrótami, na przykład ul. lub al., a także zmianę kolejności elementów adresu. Jeśli normalizacja adresu wejściowego nie jest możliwa, zwrócony rozpoznany adres to adres wejściowy. Wartości niedotyczące adresu są odrzucane.
- W drugim kroku interfejs API próbuje przeprowadzić standaryzację znormalizowanego adresu, szukając możliwego lub rzeczywistego adresu, którego prawdopodobnie chciał użyć użytkownik. Jeśli standaryzacja nie powiedzie się, zwrócony rozpoznany adres będzie miał znormalizowaną postać adresu wejściowego. Aby określić problemy dotyczące przesłanego adresu, zapoznaj się ze zwróconymi elementami.
- Niektóre elementy znormalizowanego adresu także są zwracane. Jeśli standaryzacja powiedzie się, zwrócony rozpoznany adres będzie rzeczywistym adresem. W takim przypadku różne dodatkowe elementy adresu poddanego standaryzacji oraz informacje o jego utworzeniu na podstawie znormalizowanego adresu są także zwracane.
Wartości zwracane przez interfejs API Address Validation
Jeśli zwrócony adres zawiera następujące wartości poniższych atrybutów, adres jest poprawny:
- Atrybut stanu adresu ma wartość oznaczającą standaryzację
- Atrybuty rozpoznanego adresu mają wartość prawda
- Atrybut prawidłowego miejsca dostawy (Delivery Point Valid, DPV) ma wartość prawda
- Atrybut interpolowanego adresu ma wartość fałsz
W przypadku braku tych wartości użyj dodatkowych atrybutów, aby ustalić możliwe problemy dotyczące wartości adresów.
Aby dowiedzieć się więcej na temat atrybutów adresów, zapoznaj się z informacjami na ich temat.
Jeśli zwrócone dane wyjściowe zawierają komunikat klienta INTERPOLATED.STREET.ADDRESS, adres może nie być poprawny. Aby uzyskać więcej informacji o kodzie komunikatu klienta, zapoznaj się z opisem elementu komunikatu klienta.
Obszar zurbanizowany (Urbanization) (tylko Portoryko): ten deskryptor jest często używany w obszarach miejskich Portoryko. Jest on ważną częścią formatu adresu, ponieważ opisuje lokalizację danej ulicy. W Portoryko w ramach tego samego kodu pocztowego mogą istnieć powtarzające się nazwy ulic i zakresy numerów budynków. Takie ulice mogą mieć identyczne zakresy numerów budynków. W takich przypadkach nazwa obszaru zurbanizowanego jest wymagana do prawidłowej identyfikacji lokalizacji konkretnego adresu.
Przykład: Sr Pedro Rivera Urb Hermosillo 123 Calle 1 Bayamon, PR 00961-1212.
Adnotacje
Interfejs API weryfikacji adresu zwraca adnotacje z każdym zweryfikowanym i zwróconym adresem. Adnotacje umożliwiają zapoznanie się z wadami (jeśli występują) oraz zmianami wprowadzonymi w adresie wejściowym w celu uzyskania rzeczywistego adresu.
Klasyfikacja adresu
Interfejs API weryfikacji adresu używa danych referencyjnych do określania klasyfikacji danego adresu. Klasyfikacja adresu funkcjonalnego jest ustalana niezależnie od procesu weryfikacji adresu. Jest ona oparta na informacjach zwrotnych personelu operacyjnego (komercyjne źródła danych są używane wyłącznie w celu potwierdzenia danych).
Interfejs API weryfikacji adresu obsługuje tylko cztery możliwe klasyfikacje adresów: nieznany, firmowy, domowy i mieszany. Początkowa klasyfikacja wszystkich adresów to „nieznany”. Jest ona zmieniana dopiero, gdy wynika to z reguł biznesowych weryfikacji adresu. Lokalizacja ma klasyfikację „mieszany”, tylko jeśli z adresu korzysta wielu najemców/mieszkańców i znajdują się pod nim zarówno siedziby firm, jak i bloki mieszkalne.
Uwaga: usługa FedEx Express zapewnia dodatkowy wiersz adresu (wiersz adresu 3) na adresy odbiorcy. Dodatkowe informacje adresowe to bardziej kompletne i dokładne szczegóły lokalizacji, które zwiększają szanse na uzyskanie dokładnego adresu.
Rzeczywiste adresy są klasyfikowane w następujący sposób:
Adres firmowy
Adres firmowy to adres głównego miejsca prowadzenia działalności. To miejsce, w którym firma prowadzi działalność, ale nie musi tak być zawsze.
Adres firmowy to oficjalna siedziba firmy. Może to być adres domowy lub adres wartego wiele milionów dolarów kompleksu, na przykład należącego do dużej firmy technologicznej, a także lokalizacje o wielkości i charakterze między tymi dwoma lokalizacjami.
Adres zamieszkania
Opłata za doręczenie na adres prywatny dotyczy przesyłek do prywatnego domu lub mieszkania na terenie Stanów Zjednoczonych. Obejmuje to również firmy prowadzone z domu. Aby wysłać przesyłkę na adres prywatny, użyj usługi FedEx Home Delivery z doręczeniem w 1 dzień roboczy FedEx Ground (na podstawie odległości do miejsca przeznaczenia).
Przykład:
- Probostwo
- Klasztor
- Plebania
- Mieszkańcy budynków z wieloma mieszkaniami:
- Bloki mieszkalne
- Kondominia
- Akademiki
- Mieszkanie/dom, w którym produkty są sprzedawane i/lub dystrybuowane
Porady dotyczące używania interfejsu API Address Validation
Poniżej znajdują się przydatne porady dotyczące używania interfejsu API weryfikacji adresu:
- Używaj prawidłowych odstępów: upewnij się, że odstępy są umieszczone prawidłowo. Unikaj zbędnych odstępów.
- Nie rób błędów ortograficznych: unikaj błędów ortograficznych i typograficznych. Upewnij się też, że w sposób prawidłowy użyto cyfry zero (0) i litery O.
- Unikaj znaków specjalnych: nie używaj znaków specjalnych, które nie są wymagane w adresie, na przykład kropek po skrótach (Ave v. Ave.).
- Podaj dodatkowe informacje adresowe: podając dodatkowe informacje adresowe, możesz zwiększyć dokładność rezultatów dotyczących adresu.
- Numer budynku lub domu: 1, 1A, 1½, One
- Nazwa ulicy: Main, George Washington, 42nd
- Przyrostek ulicy: Road, Avenue, Rd, Ave
- Wprowadź nazwę miasta, stanu/prowincji/województwa i kod pocztowy: podanie wszystkich trzech informacji zwiększa dokładność rezultatów dotyczących adresu.
- Zachowaj odpowiednią kolejność elementów adresu: format adresu ulicy w Stanach Zjednoczonych zwykle zaczyna się od numeru budynku lub domu, po którym występuje element wskazujący, nazwa ulicy, typ lub przyrostek ulicy, informacja o kierunku, oznaczenie mieszkania, numer mieszkania lub numer i oznaczenie prywatnej skrzynki pocztowej.
- Używaj prawidłowych skrótów: U.S. Postal Service i Canada Post stosują standardowe skróty dotyczące stanu/prowincji, przyrostka ulicy oraz oznaczeń dotyczących mieszkania lub bloku.
- Niestandardowy skrót może powodować niedokładne wyniki wyszukiwania.
- W przypadku wątpliwości dotyczących skrótu nie należy go używać.
- Obszar zurbanizowany (Urbanization) — nazwa obszaru zurbanizowanego oznacza obszar, sektor lub obszar zabudowy mieszkaniowej w obszarze geograficznym.
Na przykład:
- Numer budynku lub domu, na przykład: 1, 1A, One.
- Nazwa ulicy, na przykład Main, George Washington, 42nd.
- Przedrostek ulicy, na przykład Road, Avenue, Rd, Ave.
- Wprowadź nazwę miasta, stanu/prowincji/województwa i kod pocztowy: podanie wszystkich informacji adresowych zwiększa dokładność rezultatów dotyczących adresu. Część ZIP+4 kodu pocztowego nie jest wymagana do sprawdzenia adresu.
- Używaj prawidłowych skrótów: United States Postal Service i urzędy pocztowe w innych krajach stosują standardowe skróty dotyczące stanu/prowincji/województwa, przyrostka ulicy oraz oznaczeń dotyczących mieszkania/bloku. Niestandardowy skrót może powodować niedokładne wyniki wyszukiwania. W przypadku wątpliwości dotyczących skrótu nie należy go używać.
- Rozważ przekazanie użytkownikowi uwag dotyczących weryfikacji adresu, aby mógł wybrać adres, który według niego jest najbardziej trafny.
Reguły biznesowe
- Tego interfejsu API nie należy używać do określania możliwości doręczenia paczek na dany adres. FedEx nie oferuje usługi doręczania na każdy poprawny adres. FedEx nie wykonuje doręczeń do skrytek pocztowych (z wyjątkiem przesyłek FedEx Ground® Economy, znanych wcześniej jako FedEx SmartPost®).
- Informacje zwracane w wyniku rozpoznania adresu mają tylko charakter podpowiedzi.
- Jedno żądanie umożliwia sprawdzenie do 100 adresów.
- Minimalne wymagane pola różnią się zależnie od kraju.
Na przykład w przypadku adresów w Stanach Zjednoczonych wymagany jest co najmniej jeden wiersz adresu oraz kod pocztowy lub nazwa miasta i kod stanu. Jednak w przypadku australijskiego formatu adresu kod stanu może zostać pominięty nawet w przypadku braku kodu pocztowego.
- Rezultaty rozpoznawania adresu różnią się zależnie od kraju/terytorium.
Uwaga: interfejs API weryfikacji adresu może nie mieć zastosowania w przypadku wszystkich krajów. Więcej informacji zawiera sekcja Kraje/terytoria, w których obsługiwany jest interfejs API weryfikacji adresu.
Kolekcja JSON API
Response