Data8 資料增益
Data8 可協助您建立對資料的信心。 我們可以透過清理和豐富您現有的資料來為您節省資金,並確保在入口點只輸入最高品質的資料,讓您專注於定位和與正確的客戶溝通。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | 技術服務台 |
| URL | https://www.data-8.co.uk |
| helpdesk@data-8.co.uk |
| 連接器中繼資料 | |
|---|---|
| Publisher | 數據8有限公司 |
| 網站 | https://www.data-8.co.uk |
| 隱私策略 | https://www.data-8.co.uk/privacy-policy/ |
| 類別 | 人工智慧;網站 |
Data8 Data Enrichment 提供了許多允許控制數據質量的操作 - 確保在系統中輸入的任何數據都是真實、有效、最新的並按要求運行。 在 AI 和 Copilot 的世界中,數據是核心,Data8 可幫助您最大限度地利用您最珍貴的資產。
先決條件
- 一個 Data8 帳戶,每個動作都有積分
- 從 Data8 帳戶產生的 API 金鑰
如何取得認證
擁有 Data8 帳戶後,您可以從 Data8 儀表板獲取 API 密鑰。
開始使用連接器
所有 Data8 動作都直接來自 Data8 API - 請參閱每個端點的適用文件頁面及其運作方式 - https://www.data-8.co.uk/resources/api-reference/
常見錯誤和補救措施
Data8 支持團隊隨時可以在出現任何問題時提供幫助 - helpdesk@data-8.co.uk
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 可共用 |
預設
適用:所有地區
建立連線的參數。
這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | securestring | 此 API 的 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| CTPS 檢查 |
檢查電話號碼是否已在 CTPS 上註冊。 |
|
Predictive |
使用 Data8 PredictiveAddress API 向下切入 - 進一步向下切入搜尋結果 |
|
Predictive |
使用 Data8 PredictiveAddress API 搜尋 - 在許多資料來源中搜尋部分地址 |
|
Predictive |
使用 Data8 PredictiveAddress API 擷取 - 擷取完整位址 |
| TPS檢查 |
檢查電話號碼是否已在 TPS 上註冊。 |
| 乾淨地址 |
將給定地址格式化、驗證和更正為完整格式的地址。 |
| 已故 |
英國 - 使用定期更新的可靠來源,快速輕鬆地識別死者。 |
| 檢查可用名稱 |
檢查、驗證和驗證所提供的名稱是否可能是真實且可用的名稱,或者它是否不可用、褻瀆、隨機或空白。 |
| 清理電子郵件 |
清理電子郵件地址,驗證它以查看它是否是真實的電子郵件,但也獲取其他詳細信息,例如名稱或公司名稱以進一步豐富 |
| 獲取完整地址 |
根據輸入資料(例如建築物編號和郵遞區號)搜尋地址 |
| 驗證銀行帳戶資訊 |
檢查分類代碼和銀行帳號是否有效。 |
| 驗證電子郵件地址 |
檢查、驗證和驗證,看看電子郵件地址是否有效、真實,並且如果發送了電子郵件,則會收到電子郵件。 這充當即時電子郵件驗證服務。 |
| 驗證電話號碼 |
檢查電話號碼是否有效以接聽電話。 它將實時檢查電話線的當前狀態並返回響應。 |
| 驗證電話號碼 (已棄用) |
檢查輸入的電子郵件地址是否對接收電子郵件有效 - 這已被取代,取而代之的是 PhoneValidation |
CTPS 檢查
檢查電話號碼是否已在 CTPS 上註冊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電話號碼
|
number | True | string |
您希望 CTPS 檢查的電話號碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
可呼叫
|
Callable | boolean |
傳回布林值,讓您知道它是否可呼叫。 如果為false,則該號碼目前位於CTPS上。 |
|
電話號碼
|
TelephoneNumber | string |
如果已填入,則電話號碼是可撥打的,如果未填入,則為空值 |
PredictiveAddress (向下切入)
使用 Data8 PredictiveAddress API 向下切入 - 進一步向下切入搜尋結果
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
國家
|
country | True | string |
搜尋的 ISO 2 字元國家/地區代碼,即「GB」 |
|
Id
|
id | True | string |
應該在這裡提供來自 Search 或 DrillDown 方法先前要求回應的 value 屬性。 |
|
包括MR
|
IncludeMR | boolean |
在結果中包含來自多重居住資料庫的地址(需要額外的授權)。 |
|
|
包括紐約
|
IncludeNYB | boolean |
在結果中包含「尚未建置」資料庫中的位址(需要額外的授權)。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
Results
|
Results | array of object |
Results |
|
標籤
|
Results.label | string |
要向使用者顯示的值。 |
|
價值觀
|
Results.value | string |
可提供給 DrillDown 或 Retrieve 端點之相符的唯一識別碼。 |
|
容器
|
Results.container | boolean |
指出此相符項是否是其他地址(例如城鎮、街道等)的容器。 如果為 true,則應該將值提供給 DrillDown 端點,以取得容器記錄中位址的詳細資料。 如果為 false,則應該將值提供給 Retrieve 端點,以取得位址的完整詳細資料。 |
|
物品
|
Results.items | integer |
可能相符的清單。 |
|
Count
|
Count | integer |
根據提供的資訊找到的相符項目數量。 |
|
SessionID
|
SessionID | string |
回應中也包含 SessionID。 這應該包含在搜尋端點的任何後續呼叫中。 |
PredictiveAddress (搜尋)
使用 Data8 PredictiveAddress API 搜尋 - 在許多資料來源中搜尋部分地址
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
國家
|
country | True | string |
地址所屬的 ISO-2 國家/地區代碼。 |
|
搜尋
|
search | True | string |
使用者輸入的部分位址。 |
|
電話號碼
|
telephoneNumber | string |
選用參數,可以提供與地址相關聯的電話號碼。 |
|
|
Session
|
session | string |
在上一個回應中收到的工作階段識別碼。 這提高了效率和查找速度。 這應該包含在搜尋端點的任何後續呼叫中。 |
|
|
包括MR
|
IncludeMR | boolean |
在結果中包含來自多重居住資料庫的地址(需要額外的授權)。 |
|
|
包括紐約
|
IncludeNYB | boolean |
在結果中包含「尚未建置」資料庫中的位址(需要額外的授權)。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
Results
|
Results | array of object |
Results |
|
標籤
|
Results.label | string |
要向使用者顯示的值。 |
|
value
|
Results.value | string |
value |
|
容器
|
Results.container | boolean |
指出此相符項是否是其他地址(例如城鎮、街道等)的容器。 如果為 true,則應該將值提供給 DrillDown 端點,以取得容器記錄中位址的詳細資料。 如果為 false,則應該將值提供給 Retrieve 端點,以取得位址的完整詳細資料。 |
|
物品
|
Results.items | integer |
可能相符的清單。 |
|
Count
|
Count | integer |
Count |
|
SessionID
|
SessionID | string |
回應中也包含 SessionID。 這應該包含在搜尋端點的任何後續呼叫中。 |
PredictiveAddress (擷取)
使用 Data8 PredictiveAddress API 擷取 - 擷取完整位址
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
國家
|
country | True | string |
地址所屬的 ISO-2 國家/地區代碼。 |
|
Id
|
id | True | string |
當容器屬性為 false 時,應該在這裡提供來自 Search 或 DrillDown 方法先前要求回應的 value 屬性。 |
|
最大線長
|
MaxLineLength | integer |
最大線長 |
|
|
最大線
|
MaxLines | integer |
最大線 |
|
|
固定鎮縣
|
FixTownCounty | boolean |
固定鎮縣 |
|
|
固定郵遞區號
|
FixPostcode | boolean |
固定郵遞區號 |
|
|
修復建築
|
FixBuilding | boolean |
修正建置 |
|
|
不需要的標點符號
|
UnwantedPunctuation | string |
不需要的標點符號 |
|
|
Formatter
|
Formatter | string |
Formatter |
|
|
包括UDPRN
|
IncludeUDPRN | boolean |
包括UDPRN |
|
|
包括UPRN
|
IncludeUPRN | boolean |
包括UPRN |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
䋥
|
Result.Address.Lines | array of string |
䋥 |
|
組織
|
Result.RawAddress.Organisation | string |
地址上的公司名稱 |
|
部門
|
Result.RawAddress.Department | string |
地址所在的組織內部門 |
|
位址金鑰
|
Result.RawAddress.AddressKey | integer |
與 OrganisationKey 和 PostcodeType 結合,為此地址提供唯一金鑰 |
|
組織鍵
|
Result.RawAddress.OrganisationKey | integer |
與 AddressKey 和 PostcodeType 結合,為此位址提供唯一的金鑰。 住宅地址將為 0 |
|
郵遞區號類型
|
Result.RawAddress.PostcodeType | string |
指出位址是位於「小型使用者」(「S」)還是「大型使用者」(「L」)上。 大用戶郵遞區號是指作為大量郵件用戶分配給個別機構的郵遞區號,例如 DVLA |
|
建築物編號
|
Result.RawAddress.BuildingNumber | integer |
地址的門牌號碼。 請注意,這只是一個整數。 12A 等建築編號將顯示在 BuildingName 欄位中 |
|
子建築名稱
|
Result.RawAddress.SubBuildingName | string |
地址的子建築名稱。 這通常是公寓或公寓號碼 |
|
建築名稱
|
Result.RawAddress.BuildingName | string |
建築物的名稱。 可能包含數字信息,其中數字不是簡單的整數 |
|
DependentThoroughfareName (相依大道名稱)
|
Result.RawAddress.DependentThoroughfareName | string |
相依通道的名稱,即較大街道的較小街道 |
|
DependentThoroughfareDesc
|
Result.RawAddress.DependentThoroughfareDesc | string |
相依通道的描述符(“街道”、“道路”等) |
|
大道名稱
|
Result.RawAddress.ThoroughfareName | string |
主要街道的名稱 |
|
大道描述
|
Result.RawAddress.ThoroughfareDesc | string |
主要街道的描述符 |
|
DoubleDependentLocality
|
Result.RawAddress.DoubleDependentLocality | string |
雙依賴產地的名稱-三級產地 |
|
相依地區
|
Result.RawAddress.DependentLocality | string |
相依地區名稱 - 第二級地區 |
|
地區
|
Result.RawAddress.Locality | string |
頂級郵政小鎮的名字 |
|
郵遞區號
|
Result.RawAddress.Postcode | string |
固定 7 個字元格式的郵遞區號 |
|
DPS
|
Result.RawAddress.Dps | string |
2 個字元的遞送點字尾,可唯一識別郵遞區號內的地址 |
|
郵政信箱
|
Result.RawAddress.PoBox | string |
郵政信箱的詳細信息(如果地址是郵政信箱地址) |
|
郵政縣
|
Result.RawAddress.PostalCounty | string |
地址中應出現的縣名 |
|
傳統縣
|
Result.RawAddress.TraditionalCounty | string |
傳統上與地址相關聯但現在不需要郵寄的縣名 |
|
行政縣
|
Result.RawAddress.AdministrativeCounty | string |
地址所在的縣用於行政目的,但不需要郵寄 |
|
國家ISO2
|
Result.RawAddress.CountryISO2 | string |
與地址相關的 2 個字元的 ISO 國家/地區代碼。 AddressCapture 服務不會填入此專案 |
|
唯一參考
|
Result.RawAddress.UniqueReference | string |
地址的替代唯一參考號。 這是透過提供 IncludeUDPRN 選項給方法,將此設定為位址的 UDPRN 號碼 |
|
東距
|
Result.RawAddress.Location.Easting | integer |
OS 網格原點以東到 Scilly 西南的郵遞區號距離 |
|
北方
|
Result.RawAddress.Location.Northing | integer |
郵遞區號在作業系統方格原點以北的距離 |
|
網格參考
|
Result.RawAddress.Location.GridReference | string |
郵遞區號的位置作為 6 位數的作業系統網格參考 |
|
經度
|
Result.RawAddress.Location.Longitude | float |
郵遞區號的經度在 WGS84 基準面中以十進制度表示 |
|
緯度
|
Result.RawAddress.Location.Latitude | float |
郵遞區號的緯度在 WGS84 基準面中以十進制度表示 |
|
縣代碼
|
Result.RawAddress.Location.CountyCode | string |
地址中應出現的縣代碼 |
|
縣
|
Result.RawAddress.Location.County | string |
地址中應出現的縣名 |
|
地區代碼
|
Result.RawAddress.Location.DistrictCode | string |
地址中應出現的地區代碼 |
|
區
|
Result.RawAddress.Location.District | string |
地址中應出現的地區 |
|
病房代碼
|
Result.RawAddress.Location.WardCode | string |
郵遞區號所在區的參考代碼 |
|
Ward
|
Result.RawAddress.Location.Ward | string |
郵遞區號所在選區的名稱 |
|
國家
|
Result.RawAddress.Location.Country | string |
與地址相關的 2 個字元的 ISO 國家/地區代碼。 |
|
其他數據
|
Result.RawAddress.AdditionalData | string |
傳回的任何其他資料 |
TPS檢查
檢查電話號碼是否已在 TPS 上註冊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電話號碼
|
number | True | string |
您要檢查 TPS 的電話號碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
可呼叫
|
Callable | boolean |
傳回布林值,讓您知道它是否可呼叫。 如果為 false,則該數字目前位於 TPS 上。 |
|
電話號碼
|
TelephoneNumber | string |
如果可呼叫,則傳回電話號碼,如果不能,則傳回 Null。 |
乾淨地址
將給定地址格式化、驗證和更正為完整格式的地址。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
䋥
|
Lines | True | array of string |
䋥 |
|
預設國家/地區代碼
|
DefaultCountryCode | string |
除非另有說明,否則國家/地區假設地址所在的 ISO 2 字元代碼。 預設為 GB。 |
|
|
自動偵測國家/地區
|
DetectCountry | boolean |
設定為 true 可嘗試從提供的地址資訊中自動偵測國家/地區,並可能覆寫預設國家/地區 |
|
|
國家
|
Country | string |
如果 DetectCountry 設定為 true,則會將此視為位址旁邊的其他使用者輸入,以影響國家/地區偵測函式。 此格式未強制執行,因此可以提供為「US」、「USA」或「United States」 |
|
|
包括國家/地區
|
IncludeCountry | boolean |
在結果的主要部分中包含 CountryName 欄位 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
䋥
|
Result.Address.Lines | array of string |
䋥 |
|
比賽等級
|
MatchLevel | string |
包含 MatchLevel 以指出位址與 PAF 的比對程度。 可能的值為 OK_Unchanged、OK_Corrected、NOK_Building、NOK_Street、NOK_Town NOK_NoMatch |
|
國家名稱
|
CountryName | string |
包含地址所在國家/地區的名稱。 |
已故
英國 - 使用定期更新的可靠來源,快速輕鬆地識別死者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Title
|
Title | string |
要搜尋的名稱標題 |
|
|
名字
|
Forename | string |
要搜尋的名稱的名字 |
|
|
中間名
|
MiddleName | string |
要搜尋的名稱的中間名 |
|
|
Surname
|
Surname | True | string |
要搜尋的姓名 |
|
䋥
|
Lines | True | array of string |
䋥 |
|
Marketing
|
marketing | True | boolean |
一個布林值,用於確定搜索是否出於營銷原因進行。 |
|
比賽等級
|
MatchLevel | string |
輸入記錄中提供的名稱與參考資料檔中的名稱之間的最小比對層次。 S 是姓氏,I 是首字母,F 是名字 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
成功 |
|
錯誤訊息
|
Status.ErrorMessage | string |
錯誤訊息 (如果適用) |
|
學分剩餘
|
Status.CreditsRemaining | float |
剩餘積分 |
|
已故
|
Result | boolean |
指示該人是否被發現已死亡 |
檢查可用名稱
檢查、驗證和驗證所提供的名稱是否可能是真實且可用的名稱,或者它是否不可用、褻瀆、隨機或空白。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Title
|
Title | string |
名稱的標題 |
|
|
名字
|
Forename | string |
全名的名字 |
|
|
中間名
|
MiddleName | string |
全名的中間名 |
|
|
姓氏
|
Surname | string |
全名的姓氏 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
Result
|
Result | string |
空白值表示名稱是可用的名稱。 如果傳回值,它將是下列其中一項:「IncompleteName」、「RandomName」或「SalaciousName」 |
清理電子郵件
清理電子郵件地址,驗證它以查看它是否是真實的電子郵件,但也獲取其他詳細信息,例如名稱或公司名稱以進一步豐富
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電子郵件地址
|
True | string |
您要驗證的電子郵件地址 |
|
|
Level
|
Level | True | string |
您要驗證的層級。 這應該一律位於要求內文中,絕不會在 url 中,也絕不會在查詢參數中。 如果不確定,則預設為伺服器」 |
|
Title
|
Title | string |
輸入姓名的標題或稱呼,用於幫助確定電子郵件地址是否有效且正確 |
|
|
名字
|
Forename | string |
輸入的姓名的名字,用於幫助確定電子郵件地址是否有效且正確 |
|
|
中間名
|
MiddleName | string |
輸入名稱的中間名,用於幫助確定電子郵件地址是否有效且正確 |
|
|
Surname
|
Surname | string |
輸入的姓名的姓氏,用於幫助確定電子郵件地址是否有效且正確 |
|
|
公司
|
Company | string |
公司名稱,以協助識別電子郵件是否正確 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
學分剩餘
|
Status.CreditsRemaining | integer |
Data8 被叫服務的剩餘積分 |
|
Result
|
Result | string |
包含狀態碼,指出是否可以驗證電子郵件地址。 |
|
原始有效
|
OriginalValid | boolean |
原始有效 |
|
電子郵件類型
|
EmailType | string |
所提供電子郵件的類型及其分類方式 |
|
建議的電子郵件地址
|
SuggestedEmailAddress | string |
建議的電子郵件地址以改善此電子郵件 (如果提供的話) 應該顯示,以便使用者可以選擇使用它。 |
|
評論
|
Comment | string |
幫助者評論為什麼提出建議以提供額外的上下文 |
|
問候
|
Salutation | string |
可以使用這封電子郵件的稱呼 - 即將電子郵件發送給誰。 |
|
StructureUsed
|
StructureUsed | string |
StructureUsed |
|
ParsedName
|
ParsedName | string |
ParsedName |
獲取完整地址
根據輸入資料(例如建築物編號和郵遞區號)搜尋地址
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
許可證
|
licence | True | string |
由於 Royal Mail PAF 資料庫可以透過多種方式獲得授權,因此此參數會指出您存取資料的授權。 這必須與您擁有授權或抵免額的變體相符 - 如果您不確定要選擇哪個選項,請聯絡您的客戶經理 |
|
郵遞區號
|
postcode | True | string |
要獲取地址的完整郵政編碼。 郵遞區號的格式無關緊要,因此“ch24ne”、“CH2 4NE”、“ch02 4Ne”都可以接受。 |
|
建築
|
building | string |
一個可選值,用於按建築物名稱、編號、子場所(例如單位編號)或公司名稱過濾傳回的地址。 如果提供 null 或 “”,則郵遞區號上的所有地址都會包含在結果中。 |
|
|
固定鎮縣
|
FixTownCounty | boolean |
true 以確保在最後兩行地址行中傳回城鎮和縣,如果它們應該出現在第一個可用行中,則為 false。 |
|
|
最大線
|
MaxLines | integer |
要格式化地址的行數。 郵遞區號的結果中將包含額外的一行。 |
|
|
最大線長
|
MaxLineLength | integer |
每個地址行中可以出現的字元數上限。 |
|
|
正規化案例
|
NormalizeCase | boolean |
將地址中除城鎮名稱之外的所有文字轉換為適當的大小寫。 |
|
|
正規化城鎮案例
|
NormalizeTownCase | boolean |
將城鎮名稱轉換為適當的大小寫 |
|
|
Exclude縣
|
ExcludeCounty | boolean |
從格式化地址中排除縣 (如果有的話) |
|
|
使用AnyAvailableCounty
|
UseAnyAvailableCounty | boolean |
使用任何可用的縣來填入格式化的地址,而不只是郵政縣 |
|
|
不需要的標點符號
|
UnwantedPunctuation | boolean |
包含要從格式化位址中移除的任何標點符號字元的字串 |
|
|
修正建置
|
FixBuilding | boolean |
確保建築物名稱/編號始終位於第一行 |
|
|
包括UDPRN
|
IncludeUDPRN | boolean |
設定為 true ,讓每個傳回位址的 UniqueReference 欄位填入 UDPRN |
|
|
包含位置
|
IncludeLocation | boolean |
設定為 true,讓每個傳回地址的 [位置] 欄位填入地址的地理編碼詳細資料 |
|
|
傳回結果計數
|
ReturnResultCount | boolean |
指出是否應該使用傳回的位址總數填入結果中的 ResultCount 欄位。 |
|
|
包括紐約
|
IncludeNYB | boolean |
設定為 true,可在結果中包含「尚未建置」資料庫中的位址 (需要額外的授權) |
|
|
包括MR
|
IncludeMR | boolean |
設定為 true,可在結果中包含來自多重居住資料庫的位址 (需要額外的授權) |
|
|
Formatter
|
Formatter | string |
從可用的格式化程式之一中選擇,以控制原始位址如何轉換為人類可讀的位址 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
成功 |
|
錯誤訊息
|
Status.ErrorMessage | string |
錯誤訊息 (如果適用) |
|
學分剩餘
|
Status.CreditsRemaining | float |
剩餘積分 |
|
包含 結果 欄位中的地址數目。 只有在 ReturnResultCount 選項設定為 true 時,才會填入此欄位
|
ResultCount | integer | |
|
Results
|
Results | array of object |
Results |
|
䋥
|
Results.Address.Lines | array of string |
格式化地址行 |
|
組織
|
Results.RawAddress.Organisation | string |
組織 |
|
部門
|
Results.RawAddress.Department | string |
部門 |
|
位址金鑰
|
Results.RawAddress.AddressKey | integer |
位址金鑰 |
|
組織鍵
|
Results.RawAddress.OrganisationKey | integer |
機構關鍵 |
|
郵遞區號類型
|
Results.RawAddress.PostcodeType | string |
郵遞區號類型 |
|
建築物編號
|
Results.RawAddress.BuildingNumber | integer |
建築物編號 |
|
子建築名稱
|
Results.RawAddress.SubBuildingName | string |
子建築名稱 |
|
建築名稱
|
Results.RawAddress.BuildingName | string |
建築物名稱 |
|
DependentThoroughfareName (相依大道名稱)
|
Results.RawAddress.DependentThoroughfareName | string |
從屬通道名稱 |
|
DependentThoroughfareDesc
|
Results.RawAddress.DependentThoroughfareDesc | string |
相依通道描述 |
|
大道名稱
|
Results.RawAddress.ThoroughfareName | string |
大道名稱 |
|
大道描述
|
Results.RawAddress.ThoroughfareDesc | string |
大道描述 |
|
DoubleDependentLocality
|
Results.RawAddress.DoubleDependentLocality | string |
雙重相依地區 |
|
相依地區
|
Results.RawAddress.DependentLocality | string |
相依地區 |
|
地區
|
Results.RawAddress.Locality | string |
地區 |
|
郵遞區號
|
Results.RawAddress.Postcode | string |
郵遞區號 |
|
dps
|
Results.RawAddress.Dps | string |
DPS |
|
郵政信箱
|
Results.RawAddress.PoBox | string |
郵政信箱 |
|
郵政縣
|
Results.RawAddress.PostalCounty | string |
郵政縣 |
|
傳統縣
|
Results.RawAddress.TraditionalCounty | string |
傳統縣 |
|
行政縣
|
Results.RawAddress.AdministrativeCounty | string |
行政縣 |
|
國家ISO2
|
Results.RawAddress.CountryISO2 | string |
國家 ISO2 |
|
唯一參考
|
Results.RawAddress.UniqueReference | string |
獨特參考 |
|
東距
|
Results.RawAddress.Location.Easting | integer |
東距 |
|
北方
|
Results.RawAddress.Location.Northing | integer |
北方 |
|
網格參考
|
Results.RawAddress.Location.GridReference | string |
網格參考 |
|
經度
|
Results.RawAddress.Location.Longitude | float |
經度 |
|
緯度
|
Results.RawAddress.Location.Latitude | float |
緯度 |
|
縣代碼
|
Results.RawAddress.Location.CountyCode | string |
縣代碼 |
|
縣
|
Results.RawAddress.Location.County | string |
縣 |
|
地區代碼
|
Results.RawAddress.Location.DistrictCode | string |
地區代碼 |
|
區
|
Results.RawAddress.Location.District | string |
區 |
|
病房代碼
|
Results.RawAddress.Location.WardCode | string |
病房代碼 |
|
Ward
|
Results.RawAddress.Location.Ward | string |
Ward |
|
國家
|
Results.RawAddress.Location.Country | string |
國家 |
驗證銀行帳戶資訊
檢查分類代碼和銀行帳號是否有效。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
分類代碼
|
sortCode | True | string |
您要驗證的排序代碼 |
|
銀行帳戶號碼
|
bankAccountNumber | string |
您要驗證的銀行帳號 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
有效
|
Valid | string |
指出是否可以驗證傳入的排序代碼和銀行帳號。 |
|
分類代碼
|
SortCode | string |
已驗證的排序程式碼。 |
|
帳戶號碼
|
AccountNumber | string |
已驗證的帳號。 |
|
BIC代碼
|
BICCode | string |
分類代碼表示的銀行分行的BIC代碼。 |
|
IBAN
|
IBAN | string |
分類代碼和帳號指示的銀行帳戶的 IBAN 代碼。 |
|
分行名稱
|
BranchName | string |
排序代碼所指示的銀行分行名稱。 |
|
銀行名稱簡短
|
ShortBankName | string |
排序代碼所指出的銀行簡短名稱。 |
|
銀行全名
|
FullBankName | string |
排序代碼所指出的銀行全名。 |
|
䋥
|
Address.Address.Lines | array of string |
䋥 |
|
接受 BACS 付款
|
AcceptsBACSPayments | boolean |
指出銀行分行是否可以接受透過 BACS 系統進行的付款。 |
|
接受直接扣款交易
|
AcceptsDirectDebitTransactions | boolean |
指出銀行分行是否可以接受直接扣款付款。 |
|
接受直接信貸交易
|
AcceptsDirectCreditTransactions | boolean |
指出銀行分行是否可以接受直接貸方付款。 |
|
接受未付支票索償交易
|
AcceptsUnpaidChequeClaimTransactions | boolean |
指出銀行分行是否可以接受未付支票的索賠。 |
|
接受建屋互助會信貸交易
|
AcceptsBuildingSocietyCreditTransactions | boolean |
指出銀行分行是否可以接受建屋互助會的抵免。 |
|
接受股息利息支付交易
|
AcceptsDividendInterestPaymentTransactions | boolean |
指示銀行分行是否可以接受股息利息支付。 |
|
接受直接付款指示交易
|
AcceptsDirectDebitInstructionTransactions | boolean |
指出銀行分行是否可以接受直接扣款指示。 |
|
接受 CHAPS 付款
|
AcceptsCHAPSPayments | boolean |
指出銀行分行是否可以接受透過 CHAPS 系統進行的付款。 |
|
接受支票
|
AcceptsCheques | boolean |
指出銀行分行是否接受支票付款。 |
|
接受更快的付款
|
AcceptsFasterPayments | boolean |
指出銀行分行是否可以接受更快的付款。 |
驗證電子郵件地址
檢查、驗證和驗證,看看電子郵件地址是否有效、真實,並且如果發送了電子郵件,則會收到電子郵件。 這充當即時電子郵件驗證服務。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電子郵件地址
|
True | string |
您要驗證的電子郵件地址 |
|
|
驗證級別
|
level | True | string |
您要驗證的層級。 如果不確定,則預設為「伺服器」 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
Result
|
Result | string |
包含狀態碼,指出是否可以驗證電子郵件地址。 有關可能狀態代碼的更多信息,請閱讀 https://www.data-8.co.uk/resources/support/service-documentation/email-validation/reference/isvalid |
驗證電話號碼
檢查電話號碼是否有效以接聽電話。 它將實時檢查電話線的當前狀態並返回響應。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電話號碼
|
telephoneNumber | True | string |
您要驗證的號碼 |
|
預設國家/地區代碼
|
defaultCountry | True | integer |
要檢查的 ISO 3166-1-Alpha-2 ISO2 國家代碼。 如果未提供此值,請使用目前使用者的 ISO 3166-1-Alpha-2 程式碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
電話號碼
|
Result.TelephoneNumber | string |
輸入的電話號碼格式為 |
|
驗證結果
|
Result.ValidationResult | string |
驗證電話號碼的簡單結果 |
|
驗證級別
|
Result.ValidationLevel | string |
為電話號碼找到的驗證層級。 |
|
數字類型
|
Result.NumberType | string |
指定所提供號碼的類型,即固定電話或手機 |
|
地點
|
Result.Location | string |
電話號碼的當前位置(如果有) |
|
Provider
|
Result.Provider | string |
電話號碼的網絡提供商 |
|
國碼 (地區碼)
|
Result.CountryCode | string |
電話號碼的國家 ISO2 代碼 |
|
國家名稱
|
Result.CountryName | string |
電話號碼的國家名稱 |
驗證電話號碼 (已棄用)
檢查輸入的電子郵件地址是否對接收電子郵件有效 - 這已被取代,取而代之的是 PhoneValidation
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
電話號碼
|
telephoneNumber | True | string |
您要驗證的號碼 |
|
預設國家/地區代碼
|
defaultCountry | True | string |
格式為數字,即英國的 44 |
|
使用行驗證
|
UseLineValidation | boolean |
如果設定為 true,則服務將在其識別為英國固定電話號碼的任何號碼上使用 Data8 FixlineValidation,並在所有其他號碼上使用 InternationalTelephoneValidation。 任何驗證電話都將相應地扣除 InternationalTelephoneValidation 積分或固定電話驗證積分,因此請確保您在使用此選項之前有可用的固定電話驗證積分。 此選項預設為 false。 |
|
|
使用行動驗證
|
UseMobileValidation | boolean |
如果設定為 true,則服務將在其識別為行動號碼的任何號碼上使用 Data8 MobileValidation,並在所有其他號碼上使用 InternationalTelephoneValidation。 任何驗證通話都將相應地扣除 InternationalTelephoneValidation 積分或 MobileValidation 積分,因此請確保您在使用此選項之前有可用的 MobileValidation 積分。 此選項預設為 false。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
旗標,以判斷對 Data8 的要求是否成功,而不論結果為何 |
|
錯誤訊息
|
Status.ErrorMessage | string |
傳回的錯誤訊息(如果有的話) |
|
剩餘積分
|
Status.CreditsRemaining | float |
Data8 被叫服務的剩餘積分 |
|
電話號碼
|
Result.TelephoneNumber | string |
輸入的電話號碼格式為 |
|
驗證結果
|
Result.ValidationResult | string |
驗證電話號碼的簡單結果 |
|
驗證級別
|
Result.ValidationLevel | string |
為電話號碼找到的驗證層級。 |
|
數字類型
|
Result.NumberType | string |
指定所提供號碼的類型,即固定電話或手機 |
|
地點
|
Result.Location | string |
電話號碼的當前位置(如果有) |
|
Provider
|
Result.Provider | string |
電話號碼的網絡提供商 |
|
國碼 (地區碼)
|
Result.CountryCode | string |
電話號碼的國家 ISO2 代碼 |
|
國家名稱
|
Result.CountryName | string |
電話號碼的國家名稱 |