# API 上传数据功能 - 对接文档

**Published by:** [Untitled](https://paragraph.com/@0xd570d2812d0af17b631b837d10ef456df86c47af/)
**Published on:** 2022-03-30
**URL:** https://paragraph.com/@0xd570d2812d0af17b631b837d10ef456df86c47af/api

## Content

1. 接入平台条件 合作机构 生成开发者 auth key 2. Auth Key生成流程 2.1 如何生成 在footprint页面右上角Account Settings里面找到developer，然后点击按钮生成。 2.2 如何使用 请求接口是在header带上 authertication: auth key ，示例： { "headers": { "authentication": "Your Auth Key" } } 3. 调用API通用说明 3.1 接口url 调用API服务的URL地址，目前提供了以下2个环境: 4. 数据交互规范 使用HTTPS 协议进行数据通信； 使用POST方式发送请求； 数据返回格式使用JSON 格式； 5. 上传自定义数据 5.1 新增自定义数据 5.1.1 调用场景 需要增加新的自定义数据时 5.1.2 接口名 POST /api/v1/custom/data/upload 5.1.3 请求参数数据说明 请求参数 tableFieldSchema 5.1.4 示例 { "tableName": "your_table_name", "tableFieldSchema": [ { "name": "chain", "type": "STRING" }, { "name": "time", "type": "DATETIME" } ], "updateForce": false, "resetForce": false, "tableData": [ { "chain": "BSC", "time": "2022-01-01 12:00:00" }, { "chain": "Polygon", "time": "2022-01-01 12:00:00" } ] } 5.1.5 响应数据说明 说明 返回参数必须包含code 以code 为准判断机构是否响应成功， code=0表示成功 示例 { "code": 0, "message": "success" } 6、数据展示 最终上传的数据将会在 create chart 页面的左侧栏的custom upload目录下面

## Publication Information

- [Untitled](https://paragraph.com/@0xd570d2812d0af17b631b837d10ef456df86c47af/): Publication homepage
- [All Posts](https://paragraph.com/@0xd570d2812d0af17b631b837d10ef456df86c47af/): More posts from this publication
- [RSS Feed](https://api.paragraph.com/blogs/rss/@0xd570d2812d0af17b631b837d10ef456df86c47af): Subscribe to updates