跳到主要内容

标准规范

为了简化集成并保证数据完整性，整个 API 遵循以下统一标准。

货币金额​

示例：

10000
12345
98741
1223
1
0

API 假定所有发送的货币金额均以巴西雷亚尔（BRL）为单位。金额必须以分为单位以整数形式发送。

带时区的日期时间​

部分示例：

2019-10-15T22:35:12.232-03:00
2018-05-01T13:32:11.297+00:00
2019-05-01T00:00:00.000+00:00

遵循 ISO 8601 标准表示。时区紧随时间之后，应表示该数据所在地点的时区。

验证所用格式如下：

YYYY-MM-ddThh:mm:ss.sss±hh:mm

不带时区的日期时间​

部分示例：

2019-10-15T22:35:12
2018-05-01T13:32:11
2019-05-01T00:00:00

遵循 ISO 8601 标准表示。与时区无关的数据应不带时区发送，始终以 UTC 时间表示，并用字母 Z 表示该数据为 UTC 时间。因此将验证以下格式：

YYYY-MM-ddThh:mm:ss.sssZ

日期​

部分示例：

2019-10-15
2019-01-01
2017-03-20

对于仅接受日期的字段（例如出生日期），只需发送日期，不含任何时间，格式如下：

YYYY-MM-dd

文件号码​

由于文件号码种类繁多，且许多包含非数字字符，所有文件号码均定义为字符串类型。将其定义为字符串的另一个重要原因是防止前导零丢失。本页面涵盖的文件号码均有明确的格式掩码，并将进行验证。其余文件（如 RG）因缺乏标准化而不作验证。

CPF​

符合掩码定义的有效 CPF 示例：

123.456.789-12
321.987.543-23
111.283.333-00

不符合掩码定义的无效 CPF 示例：

8.577.477-8
08.104.627/0001-23
123.456.789-1
23.456.789-01

CPF 始终定义为字符串，并将根据以下掩码进行验证：

###.###.###-##

CNPJ​

符合掩码定义的有效 CNPJ 示例：

08.104.627/0001-02
01.079.210/0114-67
32.402.502/0001-35

不符合掩码定义的无效 CNPJ 示例：

8.577.477-8
123.456.789-12
321.987.543-23
32.402.502/0001-3
032.402.502/0001-3

CNPJ 始终定义为字符串，并将根据以下掩码进行验证：

##.###.###/####-##

IP​

符合掩码定义的有效 IP 示例：

201.81.161.86
201.081.161.86
201.81.161.086
201.81.0.1

无效 IP 示例：

201.81..86
358.81.161.86
201.81.161

IP 地址必须始终以 IPv4 格式发送，可以带或不带前导零，遵循以下掩码：

###.###.###.###