跳到主要内容

Person 对象

一个账户可以有多个用户访问，因此每个用户都必须有其注册信息，以区分联名账户中的操作。以下信息必须遵循既定标准，但如有需要，任何字段都可以添加到账户数据中。

定义 Person 对象​

Request Body
{
  "person_id": "12345678",
  "document_number": "111.111.111-11",
  "registration_date": "2019-12-11T11:37:15.12-03:00",
  "person_data": {
    "name": "Joao da Silva",
    "email": "person@email.com",
    "phone": {
      "number": "999999999",
      "international_dial_code": "55",
      "area_code": "11"
    }
  }
}

人员的所有信息交换均使用以下对象定义。在某些情况下，为了方便实现并减少双方之间的数据流，部分信息可以省略。

名称类型描述
person_idstring人员标识符。
每个人员的该编号必须唯一 （必填）
document_numberstring文件编号，可以是带格式的 CPF 或 CNPJ。
registration_datedatetime与账户关联的人员注册日期和时间，含时区。（必填）
person_dataobject可以包含任何人员数据的对象。如果包含姓名 name、电子邮件 email 和电话 phone（及其字段 number、international_dial_code 和 area_code），则上述所有对象必须为 string 类型。

创建 Person​

Request Body
  {
    "person_id": "12345678",
    ...
  }
Response Body
  {
    "person_id": "12345678",
    "document_number": "111.111.111-11",
    "registration_date": "2019-12-11T11:37:15.12-03:00",
    "person_data": {
      "name": "Joao da Silva",
      "email": "person@email.com",
      "phone": {
        "number": "999999999",
        "international_dial_code": "55",
        "area_code": "11"
      }
    }
  }

要创建人员，只需将 Person 类型的对象发送到以下端点：

POST https://api.caas.qitech.app/device_manager/account/{account_id}/person