plaid - 如何从 Plaid api 获取“项目”的徽标？

Question

我查看了 API 文档，没有看到任何关于如何获取徽标的信息，但格子图案清楚地显示了它们出现在链接应用程序中的内容。有什么方法可以让我作为 API 的一部分或通过使用“项目”ID 的其他机制访问这些徽标？

Answer 1

虽然在撰写本文时没有记录，但显然可以通过将选项参数添加到值为 {"include_display_data": true} 的机构请求中来完成。使用 getInstitutionById 方法和 Vangaurd 的节点 API 看起来像这样。

client.getInstitutionById('ins_108768', {include_display_data: true} (err, result) => {
 // Handle err
 const logo = result.institution.logo;
});

logo 的值要么是 null，要么是包含 logo 二进制数据的 base64 编码字符串。

Answer 2

当前版本的格子 ruby​​ gem(6.1.0) 不检索徽标，但您可以扩展格子库并使用include_display_data参数来获取徽标。

module Plaid
  class Institutions < BaseProduct

    def get_by_id_with_logo(institution_id)
      post_with_public_key 'institutions/get_by_id',
                           SingleInstitutionResponse,
                           institution_id: institution_id,
                           options: { include_display_data: true }
    end
  end
end

用法：

ins = client.institutions.get_by_id_with_logo(YOUR_INSTITUTION_ID)
puts ins.institution[:logo]

Answer 3

要从 Plaid API 获取所有机构的列表，需要/institutions/get使用 POST 请求。要获取徽标和其他机构属性，例如主页 URL 和品牌颜色，需要options在请求的正文中添加属性，其中键=> 值对“include_optional_metadata”=> true。count 参数表示要返回的机构数（perPage），而 offset 是要跳过的机构数。

curl -X POST \
https://sandbox.plaid.com/sandbox/institutions/get \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
        "client_id": "clientIdFromPlaidDashboard",
        "secret": "secretFromPlaidDashboard",
        "count": 500,
        "offset": 0,
        "options" => [
            "include_optional_metadata" => true
         ]
    }'

Plaid doc 的预期回复：

http code 200
{
  "institutions": [
    {
      "country_codes": ["US"],
      "credentials": [{
        "label": "User ID",
        "name": "username",
        "type": "text"
       }, {
        "label": "Password",
        "name": "password",
        "type": "password"
      }],
      "has_mfa": true,
      "institution_id": "ins_109508",
      "mfa": [
        "code",
        "list",
        "questions",
        "selections"
      ],
      "name": "First Platypus Bank",
      // the following are included when
      // options.include_optional_metadata is true
      "primary_color": "#1f1f1f",
      "url": "https://plaid.com",
      "logo": null,
      ]
    }
  ],
  "request_id": "m8MDnv9okwxFNBV",
  "total": 1
}