Data8 数据扩充
Data8 可帮助你增强对数据的信心。 我们可以通过清理和丰富现有数据来节省资金,并确保只有最高质量的数据进入入口点,让你专注于目标,并传达给正确的客户。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | 技术支持人员 |
| URL | https://www.data-8.co.uk |
| helpdesk@data-8.co.uk |
| 连接器元数据 | |
|---|---|
| 发布者 | Data8 Limited |
| 网站 | https://www.data-8.co.uk |
| 隐私策略 | https://www.data-8.co.uk/privacy-policy/ |
| 类别 | 人工智能;网站 |
Data8 数据扩充提供了许多作,这些作允许控制数据质量 - 确保系统中输入的任何数据都是真实的、有效的、最新的和所需的功能。 在 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 Docs
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| API 密钥 | securestring | 此 API 的 API 密钥 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| CTPS 检查 |
检查是否在 CTPS 上注册了电话号码。 |
|
Predictive |
使用 Data8 PredictiveAddress API 进行搜索 - 搜索许多数据源中的部分地址 |
|
Predictive |
使用 Data8 PredictiveAddress API 进行检索 - 检索完整地址 |
|
Predictive |
使用 Data8 PredictiveAddress API 向下钻取 - 进一步钻取搜索结果 |
| TPS 检查 |
检查是否在 TPS 上注册了电话号码。 |
| 检查可用名称 |
检查、验证和验证提供的名称是否可能是真实且可用的名称,或者该名称是否不可用、不祥、随机或空白。 |
| 死者 |
英国 - 使用定期更新的可信消息来源,快速轻松地识别死者。 |
| 清理地址 |
将给定地址的格式、验证和更正为格式完整的地址。 |
| 清理电子邮件 |
清理电子邮件地址,验证其是否是真实的正版电子邮件,但也采取其他详细信息,如姓名或公司名称以进一步扩充 |
| 获取完整地址 |
根据输入数据(如生成号和邮政编码)搜索地址 |
| 验证电子邮件地址 |
检查、验证和验证电子邮件地址是否有效、真实,并在发送电子邮件时收到电子邮件。 这充当实时电子邮件验证服务。 |
| 验证电话号码 |
检查电话号码是否有效以接收电话呼叫。 它将实时检查电话线的当前状态并返回响应。 |
| 验证电话号码 (已弃用) |
检查输入的电子邮件地址是否有效以接收电子邮件 - 这已弃用,有利于 PhoneValidation |
| 验证银行帐户信息 |
检查排序代码和银行帐户号是否有效。 |
CTPS 检查
检查是否在 CTPS 上注册了电话号码。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
电话号码
|
number | True | string |
要进行 CTPS 检查的电话号码 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
用于确定对 Data8 的请求是否成功(无论结果如何)的标志 |
|
错误消息
|
Status.ErrorMessage | string |
返回的错误消息(如果有) |
|
剩余额度
|
Status.CreditsRemaining | float |
所调用服务的剩余 Data8 信用额度 |
|
可调用
|
Callable | boolean |
返回一个布尔值,告知你是否可调用。 如果为 false,则数字当前位于 CTPS 上。 |
|
电话号码
|
TelephoneNumber | string |
如果已填充,则电话号码是可调用的,如果没有,则为 null |
PredictiveAddress (搜索)
使用 Data8 PredictiveAddress API 进行搜索 - 搜索许多数据源中的部分地址
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
国家
|
country | True | string |
地址所属的 ISO-2 国家/地区代码。 |
|
搜寻
|
search | True | string |
用户输入的部分地址。 |
|
电话号码
|
telephoneNumber | string |
可选参数,可以提供与地址关联的电话号码。 |
|
|
Session
|
session | string |
在上一响应中收到的会话 ID。 这样可以提高效率和查找速度。 这应包含在对搜索终结点的任何后续调用中。 |
|
|
IncludeMR
|
IncludeMR | boolean |
在结果中包含来自多个驻留数据库的地址(需要其他许可)。 |
|
|
IncludeNYB
|
IncludeNYB | boolean |
包括结果中尚未生成的数据库中的地址(需要其他许可)。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
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,则应将该值提供给检索终结点以获取地址的完整详细信息。 |
|
物品
|
Results.items | integer |
可能的匹配项列表。 |
|
计数
|
Count | integer |
计数 |
|
SessionID
|
SessionID | string |
响应中还包括 SessionID。 这应包含在对搜索终结点的任何后续调用中。 |
PredictiveAddress (检索)
使用 Data8 PredictiveAddress API 进行检索 - 检索完整地址
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
国家
|
country | True | string |
地址所属的 ISO-2 国家/地区代码。 |
|
Id
|
id | True | string |
应在此处提供来自搜索或 DrillDown 方法的上一个请求的响应中的 value 属性。如果容器属性为 false,则应在此处提供。 |
|
MaxLineLength
|
MaxLineLength | integer |
MaxLineLength |
|
|
MaxLines
|
MaxLines | integer |
MaxLines |
|
|
FixTownCounty
|
FixTownCounty | boolean |
FixTownCounty |
|
|
FixPostcode
|
FixPostcode | boolean |
FixPostcode |
|
|
修复生成
|
FixBuilding | boolean |
FixBuilding |
|
|
不需要的Punctuation
|
UnwantedPunctuation | string |
不需要的Punctuation |
|
|
Formatter
|
Formatter | string |
Formatter |
|
|
IncludeUDPRN
|
IncludeUDPRN | boolean |
IncludeUDPRN |
|
|
IncludeUPRN
|
IncludeUPRN | boolean |
IncludeUPRN |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
用于确定对 Data8 的请求是否成功(无论结果如何)的标志 |
|
错误消息
|
Status.ErrorMessage | string |
返回的错误消息(如果有) |
|
剩余额度
|
Status.CreditsRemaining | float |
所调用服务的剩余 Data8 信用额度 |
|
行
|
Result.Address.Lines | array of string |
行 |
|
组织
|
Result.RawAddress.Organisation | string |
地址处的公司名称 |
|
Department
|
Result.RawAddress.Department | string |
位于地址的组织内的部门 |
|
地址密钥
|
Result.RawAddress.AddressKey | integer |
结合 OrganisationKey 和 PostcodeType 提供此地址的唯一密钥 |
|
OrganisationKey
|
Result.RawAddress.OrganisationKey | integer |
结合 AddressKey 和 PostcodeType 提供此地址的唯一键。 对于住宅地址,将为 0 |
|
PostcodeType
|
Result.RawAddress.PostcodeType | string |
指示地址是否位于“小用户”(“S”)或“大型用户”(“L”)上。 大型用户邮政编码是作为大量邮件用户(例如 DVLA)分配给单个组织的邮政编码 |
|
BuildingNumber
|
Result.RawAddress.BuildingNumber | integer |
地址的房屋编号。 请注意,这只是整数。 BuildingName 字段中将显示 12A 等建筑物编号 |
|
SubBuildingName
|
Result.RawAddress.SubBuildingName | string |
地址的子生成的名称。 这通常是平面或公寓号 |
|
BuildingName
|
Result.RawAddress.BuildingName | string |
建筑物的名称。 可能包括数字信息,其中数字不是简单的整数 |
|
DependentThoroughfareName
|
Result.RawAddress.DependentThoroughfareName | string |
依赖干道的名称,即较大街道外的较小街道 |
|
DependentThoroughfareDesc
|
Result.RawAddress.DependentThoroughfareDesc | string |
依赖干道的描述符(“street”、“road”等) |
|
ThoroughfareName
|
Result.RawAddress.ThoroughfareName | string |
主街的名称 |
|
ThoroughfareDesc
|
Result.RawAddress.ThoroughfareDesc | string |
主街的描述符 |
|
DoubleDependentLocality
|
Result.RawAddress.DoubleDependentLocality | string |
双依赖区域的名称 - 第三级区域 |
|
DependentLocality
|
Result.RawAddress.DependentLocality | string |
依赖区域的名称 - 第二级区域设置 |
|
本地性
|
Result.RawAddress.Locality | string |
顶级邮政镇的名称 |
|
邮政编码
|
Result.RawAddress.Postcode | string |
采用固定 7 个字符格式的邮政编码 |
|
DPS
|
Result.RawAddress.Dps | string |
2 个字符的传递点后缀,用于唯一标识邮政编码中的地址 |
|
PoBox
|
Result.RawAddress.PoBox | string |
如果地址是 PO Box 地址,则 PO Box 的详细信息 |
|
PostalCounty
|
Result.RawAddress.PostalCounty | string |
地址中应显示的县名称 |
|
TraditionalCounty
|
Result.RawAddress.TraditionalCounty | string |
传统上与地址关联的县名称,但现在不需要邮政 |
|
AdministrativeCounty
|
Result.RawAddress.AdministrativeCounty | string |
地址用于管理目的但不需要邮政的县 |
|
CountryISO2
|
Result.RawAddress.CountryISO2 | string |
与地址相关的 2 个字符的 ISO 国家/地区代码。 未由 AddressCapture 服务填充 |
|
UniqueReference
|
Result.RawAddress.UniqueReference | string |
地址的另一个唯一引用编号。 这通过向方法提供 IncludeUDPRN 选项,设置为地址的 UDPRN 编号 |
|
东行航程
|
Result.RawAddress.Location.Easting | integer |
OS 网格原点以东到西南部 Scilly 的邮政编码距离 |
|
北上
|
Result.RawAddress.Location.Northing | integer |
OS 网格源以北的邮政编码距离 |
|
GridReference
|
Result.RawAddress.Location.GridReference | string |
作为 6 位 OS 网格引用的邮政编码的位置 |
|
Longitude
|
Result.RawAddress.Location.Longitude | float |
WGS84 datum 中以十进制度表示的邮政编码的经度 |
|
Latitude
|
Result.RawAddress.Location.Latitude | float |
以十进制度表示的邮政编码纬度(以 WGS84 基准表示) |
|
CountyCode
|
Result.RawAddress.Location.CountyCode | string |
地址中应显示的县代码 |
|
县
|
Result.RawAddress.Location.County | string |
地址中应显示的县名称 |
|
DistrictCode
|
Result.RawAddress.Location.DistrictCode | string |
地址中显示的地区代码 |
|
区
|
Result.RawAddress.Location.District | string |
应在地址中显示的地区 |
|
WardCode
|
Result.RawAddress.Location.WardCode | string |
邮政编码位于的病房的引用代码 |
|
病房
|
Result.RawAddress.Location.Ward | string |
邮政编码位于的选举区的名称 |
|
国家
|
Result.RawAddress.Location.Country | string |
与地址相关的 2 个字符的 ISO 国家/地区代码。 |
|
其他数据
|
Result.RawAddress.AdditionalData | string |
返回的任何其他数据 |
PredictiveAddress (钻取)
使用 Data8 PredictiveAddress API 向下钻取 - 进一步钻取搜索结果
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
国家
|
country | True | string |
搜索的 ISO 2 字符国家/地区代码,即“GB” |
|
Id
|
id | True | string |
此处应提供来自搜索或 DrillDown 方法的上一个请求的响应中的 value 属性。 |
|
IncludeMR
|
IncludeMR | boolean |
在结果中包含来自多个驻留数据库的地址(需要其他许可)。 |
|
|
IncludeNYB
|
IncludeNYB | boolean |
包括结果中尚未生成的数据库中的地址(需要其他许可)。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
用于确定对 Data8 的请求是否成功(无论结果如何)的标志 |
|
错误消息
|
Status.ErrorMessage | string |
返回的错误消息(如果有) |
|
剩余额度
|
Status.CreditsRemaining | float |
所调用服务的剩余 Data8 信用额度 |
|
Results
|
Results | array of object |
Results |
|
标签
|
Results.label | string |
要向用户显示的值。 |
|
价值
|
Results.value | string |
可提供给 DrillDown 或检索终结点的匹配的唯一标识符。 |
|
集装箱
|
Results.container | boolean |
指示此匹配是否是其他地址(例如城镇、街道等)的容器。 如果为 true,则应将该值提供给 DrillDown 终结点,以获取容器记录中地址的详细信息。 如果为 false,则应将该值提供给检索终结点以获取地址的完整详细信息。 |
|
物品
|
Results.items | integer |
可能的匹配项列表。 |
|
计数
|
Count | integer |
根据提供的信息找到的匹配项数。 |
|
SessionID
|
SessionID | string |
响应中还包括 SessionID。 这应包含在对搜索终结点的任何后续调用中。 |
TPS 检查
检查是否在 TPS 上注册了电话号码。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
电话号码
|
number | True | string |
要进行 TPS 检查的电话号码 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
用于确定对 Data8 的请求是否成功(无论结果如何)的标志 |
|
错误消息
|
Status.ErrorMessage | string |
返回的错误消息(如果有) |
|
剩余额度
|
Status.CreditsRemaining | float |
所调用服务的剩余 Data8 信用额度 |
|
可调用
|
Callable | boolean |
返回一个布尔值,告知你是否可调用。 如果为 false,则数字当前位于 TPS 上。 |
|
电话号码
|
TelephoneNumber | string |
如果可呼叫,则返回电话号码,如果不是,则返回 null。 |
检查可用名称
检查、验证和验证提供的名称是否可能是真实且可用的名称,或者该名称是否不可用、不祥、随机或空白。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Title
|
Title | string |
名称的标题 |
|
|
名字
|
Forename | string |
全名的名字 |
|
|
中间名称
|
MiddleName | string |
全名的中间名称 |
|
|
姓氏
|
Surname | string |
全名的姓氏 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
用于确定对 Data8 的请求是否成功(无论结果如何)的标志 |
|
错误消息
|
Status.ErrorMessage | string |
返回的错误消息(如果有) |
|
剩余额度
|
Status.CreditsRemaining | float |
所调用服务的剩余 Data8 信用额度 |
|
结果
|
Result | string |
空值将名称索引为可用名称。 如果返回值,它将是下列值之一:“IncompleteName”、“RandomName”或“SalaciousName” |
死者
英国 - 使用定期更新的可信消息来源,快速轻松地识别死者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Title
|
Title | string |
要搜索的名称的标题 |
|
|
名字
|
Forename | string |
要搜索的名称的第一个名称 |
|
|
中间名
|
MiddleName | string |
要搜索的名称的中间名称 |
|
|
Surname
|
Surname | True | string |
要搜索的名称的姓氏 |
|
行
|
Lines | True | array of string |
行 |
|
Marketing
|
marketing | True | boolean |
一个布尔值,用于确定是否出于营销原因正在执行搜索。 |
|
匹配级别
|
MatchLevel | string |
输入记录中提供的名称与引用数据文件中的名称之间的最小匹配级别。 S 为姓氏,我是 Initial,F 为 Forename |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
成功 |
|
错误消息
|
Status.ErrorMessage | string |
错误消息(如果适用) |
|
CreditsRemaining
|
Status.CreditsRemaining | float |
剩余额度 |
|
死者
|
Result | boolean |
指示是否已发现该人员已死亡 |
清理地址
将给定地址的格式、验证和更正为格式完整的地址。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
行
|
Lines | True | array of string |
行 |
|
默认国家/地区代码
|
DefaultCountryCode | string |
要假定地址所在的国家/地区的 ISO 2 字符代码,除非另有指定。 这默认为 GB。 |
|
|
自动检测国家/地区
|
DetectCountry | boolean |
设置为 true 以尝试从提供的地址信息自动检测国家/地区,可能覆盖默认国家/地区 |
|
|
国家
|
Country | string |
如果 DetectCountry 设置为 true,则会将其作为附加的用户输入与地址一起用于影响国家/地区检测功能。 不强制实施此格式,因此可以提供为“US”、“USA”或“美国” |
|
|
包括国家/地区
|
IncludeCountry | boolean |
在结果的主部分中包括 CountryName 字段 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
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 |
包含地址所在的国家/地区的名称。 |
清理电子邮件
清理电子邮件地址,验证其是否是真实的正版电子邮件,但也采取其他详细信息,如姓名或公司名称以进一步扩充
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
电子邮件地址
|
True | string |
要验证的电子邮件地址 |
|
|
级别
|
Level | True | string |
要验证的级别。 这应始终位于请求正文中,从不位于 URL 中,也不应位于查询参数中。 如果不确定,则默认为“服务器” |
|
Title
|
Title | string |
输入的名称的标题或敬礼,用于帮助确定电子邮件地址是否有效且正确 |
|
|
名字
|
Forename | string |
输入的名称的名字,用于帮助确定电子邮件地址是否有效且正确 |
|
|
中间名
|
MiddleName | string |
输入的名称的中间名称,用于帮助确定电子邮件地址是否有效且正确 |
|
|
Surname
|
Surname | string |
输入的名称的姓氏,用于帮助确定电子邮件地址是否有效且正确 |
|
|
公司
|
Company | string |
用于确定电子邮件是否正确的公司名称 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
用于确定对 Data8 的请求是否成功(无论结果如何)的标志 |
|
错误消息
|
Status.ErrorMessage | string |
返回的错误消息(如果有) |
|
CreditsRemaining
|
Status.CreditsRemaining | integer |
所调用服务的剩余 Data8 信用额度 |
|
结果
|
Result | string |
包含一个状态代码,指示是否可以验证电子邮件地址。 |
|
OriginalValid
|
OriginalValid | boolean |
OriginalValid |
|
电子邮件类型
|
EmailType | string |
提供的电子邮件的类型及其分类方式 |
|
建议的电子邮件地址
|
SuggestedEmailAddress | string |
建议的用于改进此电子邮件的建议电子邮件地址(如果提供此地址)应显示出来,以便用户可以选择使用它。 |
|
注释
|
Comment | string |
有关为何建议提供其他上下文的帮助程序注释 |
|
称呼
|
Salutation | string |
可以使用此电子邮件的敬礼 , 即要向谁发送电子邮件。 |
|
StructureUsed
|
StructureUsed | string |
StructureUsed |
|
ParsedName
|
ParsedName | string |
ParsedName |
获取完整地址
根据输入数据(如生成号和邮政编码)搜索地址
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
许可证
|
licence | True | string |
由于皇家邮件 PAF 数据库可以通过多种方式获得许可,此参数指示你正在访问数据的许可证。 这必须与你拥有许可证或额度的变体匹配 - 如果你不确定选择哪个选项,请联系你的客户经理 |
|
邮政编码
|
postcode | True | string |
要获取其地址的完整邮政编码。 邮政编码的格式并不重要,因此“ch24ne”、“CH2 4NE”、“ch02 4Ne”全部接受。 |
|
建筑
|
building | string |
一个可选值,用于通过生成名称、数字、子本地(例如平面号)或公司名称来筛选返回的地址。 如果提供 null 或“”,则结果中包含邮政编码上的所有地址。 |
|
|
FixTownCounty
|
FixTownCounty | boolean |
true 以确保在最后两个地址行中返回城镇和县,如果它们应出现在第一个可用行中,则返回 false。 |
|
|
MaxLines
|
MaxLines | integer |
要设置地址格式的行数。 邮政编码的结果中将包含一个附加行。 |
|
|
MaxLineLength
|
MaxLineLength | integer |
每个地址行中可显示的最大字符数。 |
|
|
NormalizeCase
|
NormalizeCase | boolean |
将地址中的所有文本(城镇名称除外)转换为正确的大小写。 |
|
|
NormalizeTownCase
|
NormalizeTownCase | boolean |
将城镇名称转换为正确大小写 |
|
|
ExcludeCounty
|
ExcludeCounty | boolean |
从格式化地址中排除县(如果有) |
|
|
UseAnyAvailableCounty
|
UseAnyAvailableCounty | boolean |
使用任何可用的县填充格式化地址,而不仅仅是邮政县 |
|
|
不需要的Punctuation
|
UnwantedPunctuation | boolean |
包含要从格式化地址中删除的任何标点符号的字符串 |
|
|
FixBuilding
|
FixBuilding | boolean |
确保生成名称/编号始终放在第一行中 |
|
|
IncludeUDPRN
|
IncludeUDPRN | boolean |
设置为 true 以让每个返回的地址的 UniqueReference 字段填充 UDPRN |
|
|
IncludeLocation
|
IncludeLocation | boolean |
设置为 true,让每个返回的地址的“位置”字段填充地址的地理编码详细信息 |
|
|
ReturnResultCount
|
ReturnResultCount | boolean |
指示是否应用返回的地址总数填充结果中的 ResultCount 字段。 |
|
|
IncludeNYB
|
IncludeNYB | boolean |
设置为 true 以在结果中包含“尚未生成的”数据库中的地址(需要其他许可) |
|
|
IncludeMR
|
IncludeMR | boolean |
设置为 true 以在结果中包含多个驻留数据库中的地址(需要其他许可) |
|
|
Formatter
|
Formatter | string |
从其中一个可用的格式化程序中进行选择,以控制如何将原始地址转换为人工可读地址 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
成功 |
|
错误消息
|
Status.ErrorMessage | string |
错误消息(如果适用) |
|
CreditsRemaining
|
Status.CreditsRemaining | float |
剩余额度 |
|
包含“结果”字段中的地址数。 仅当 ReturnResultCount 选项设置为 true 时,才会填充此字段
|
ResultCount | integer | |
|
Results
|
Results | array of object |
Results |
|
行
|
Results.Address.Lines | array of string |
带格式的地址行 |
|
组织
|
Results.RawAddress.Organisation | string |
组织 |
|
Department
|
Results.RawAddress.Department | string |
Department |
|
AddressKey
|
Results.RawAddress.AddressKey | integer |
地址密钥 |
|
OrganisationKey
|
Results.RawAddress.OrganisationKey | integer |
组织密钥 |
|
PostcodeType
|
Results.RawAddress.PostcodeType | string |
邮政编码类型 |
|
BuildingNumber
|
Results.RawAddress.BuildingNumber | integer |
建筑物编号 |
|
SubBuildingName
|
Results.RawAddress.SubBuildingName | string |
子生成名称 |
|
BuildingName
|
Results.RawAddress.BuildingName | string |
建筑物名称 |
|
DependentThoroughfareName
|
Results.RawAddress.DependentThoroughfareName | string |
从属干道名称 |
|
DependentThoroughfareDesc
|
Results.RawAddress.DependentThoroughfareDesc | string |
从属干道 Desc |
|
ThoroughfareName
|
Results.RawAddress.ThoroughfareName | string |
干道名称 |
|
ThoroughfareDesc
|
Results.RawAddress.ThoroughfareDesc | string |
干道 Desc |
|
DoubleDependentLocality
|
Results.RawAddress.DoubleDependentLocality | string |
双依赖区域 |
|
DependentLocality
|
Results.RawAddress.DependentLocality | string |
从属区域 |
|
本地性
|
Results.RawAddress.Locality | string |
本地性 |
|
邮政编码
|
Results.RawAddress.Postcode | string |
邮政编码 |
|
Dps
|
Results.RawAddress.Dps | string |
DPS |
|
PoBox
|
Results.RawAddress.PoBox | string |
PO Box |
|
PostalCounty
|
Results.RawAddress.PostalCounty | string |
邮政县 |
|
TraditionalCounty
|
Results.RawAddress.TraditionalCounty | string |
传统县 |
|
AdministrativeCounty
|
Results.RawAddress.AdministrativeCounty | string |
行政县 |
|
CountryISO2
|
Results.RawAddress.CountryISO2 | string |
国家/地区 ISO2 |
|
UniqueReference
|
Results.RawAddress.UniqueReference | string |
唯一引用 |
|
东行航程
|
Results.RawAddress.Location.Easting | integer |
东行航程 |
|
北上
|
Results.RawAddress.Location.Northing | integer |
北上 |
|
GridReference
|
Results.RawAddress.Location.GridReference | string |
GridReference |
|
Longitude
|
Results.RawAddress.Location.Longitude | float |
Longitude |
|
Latitude
|
Results.RawAddress.Location.Latitude | float |
Latitude |
|
CountyCode
|
Results.RawAddress.Location.CountyCode | string |
CountyCode |
|
县
|
Results.RawAddress.Location.County | string |
县 |
|
DistrictCode
|
Results.RawAddress.Location.DistrictCode | string |
DistrictCode |
|
区
|
Results.RawAddress.Location.District | string |
区 |
|
WardCode
|
Results.RawAddress.Location.WardCode | string |
WardCode |
|
病房
|
Results.RawAddress.Location.Ward | string |
病房 |
|
国家
|
Results.RawAddress.Location.Country | string |
国家 |
验证电子邮件地址
检查、验证和验证电子邮件地址是否有效、真实,并在发送电子邮件时收到电子邮件。 这充当实时电子邮件验证服务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
电子邮件地址
|
True | string |
要验证的电子邮件地址 |
|
|
验证级别
|
level | True | string |
要验证的级别。 如果不确定,则默认为服务器 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
Status.Success | boolean |
用于确定对 Data8 的请求是否成功(无论结果如何)的标志 |
|
错误消息
|
Status.ErrorMessage | string |
返回的错误消息(如果有) |
|
剩余额度
|
Status.CreditsRemaining | float |
所调用服务的剩余 Data8 信用额度 |
|
结果
|
Result | string |
包含一个状态代码,指示是否可以验证电子邮件地址。 有关可能的状态代码的详细信息,请阅读 https://www.data-8.co.uk/resources/support/service-documentation/email-validation/reference/isvalid |
验证电话号码
检查电话号码是否有效以接收电话呼叫。 它将实时检查电话线的当前状态并返回响应。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
电话号码
|
telephoneNumber | True | string |
要验证的数字 |
|
默认国家/地区代码
|
defaultCountry | True | integer |
要检查的 ISO 3166-1-Alpha-2 ISO2 国家/地区代码。 如果未提供此值,请使用当前用户 ISO 3166-1-Alpha-2 代码 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
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
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
电话号码
|
telephoneNumber | True | string |
要验证的数字 |
|
默认国家/地区代码
|
defaultCountry | True | string |
格式为数字,即 44 表示英国 |
|
使用行验证
|
UseLineValidation | boolean |
如果设置为 true,则服务将使用 Data8 LandlineValidation 对任何号码使用它识别为英国内联号码,并在所有其他号码上使用 InternationalTelephoneValidation。 任何验证呼叫都将被借记为 InternationalTelephoneValidation 信用额度或 LandlineValidation 信用额度,因此,请确保在使用此选项之前有 LandlineValidation 信用额度。 选项默认为 false。 |
|
|
使用移动验证
|
UseMobileValidation | boolean |
如果设置为 true,则服务将使用 Data8 MobileValidation 来识别为移动号码,并在所有其他号码上使用 InternationalTelephoneValidation。 任何验证呼叫都将被借记为 InternationalTelephoneValidation 信用额度或 MobileValidation 信用额度,因此请确保在使用此选项之前有 MobileValidation 额度可用。 选项默认为 false。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
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 |
电话号码的国家/地区名称 |
验证银行帐户信息
检查排序代码和银行帐户号是否有效。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
对代码进行排序
|
sortCode | True | string |
要验证的排序代码 |
|
银行帐户号
|
bankAccountNumber | string |
要验证的银行帐户号 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
成功
|
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 |
指示银行分行是否可以接受更快的付款。 |