如何获取合合TextIn API开放平台密钥分步指南
在当今的数字媒体、软件开发及日常生活的众多场景中，集成高效、智能的文本处理功能已成为提升应用功能与用户体验的重要一环。合合TextIn API开放平台凭借其强大的文本处理能力，如自然语言处理、文本分析、信息抽取等，为开发者们提供了一个丰富多样的API服务集合，使得开发者能够轻松地将这些先进功能融入到自己的应用中。本文将作为一份详尽的分步指南，引领你逐步完成如何获取合合TextIn API开放平台密钥的全过程，确保你能够顺利地将这些强大的文本处理能力融入到你的项目中，从而为用户提供更加智能、高效的文本处理体验。接下来，让我们一同踏上这段探索之旅，深入了解如何获取合合TextIn API开放平台密钥的每一个步骤。
1. 创建或登录到合合TextIn API开放平台
2. 获取密钥
在工作台总览页面中，右侧用户信息最下方可查看您的app-id。
或在工作台中选择左侧菜单栏中“账号管理”页面，在“开发者信息”栏中即可获取。
3. 代码接入
请求URL
https://api.textin.com/ai/service/v1/pdf_to_markdown
HTTP请求方法（Method）
HTTP POST
请求头说明（Request Headers）
请在HTTP请求中添加以下自定义标头（Header）。
| header 名 | 值 |
|---|---|
| x-ti-app-id | 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id |
| x-ti-secret-code | 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code |
URL参数（Parameters）
URL参数指以
{参数名}={参数值} 形式拼接到 URL 上的键值对。它以?开头，不同参数之间使用&连接。形如?p1=v1&p2=v2
| 参数名 | 数据类型 | 是否必填 | 允许的值 | 描述 |
|---|---|---|---|---|
| pdf_pwd | string | 否 | 见描述 | 当pdf为加密文档时，需要提供密码。 备注：对前端封装该接口时，需要自行对密码进行安全防护 |
| char_details | integer | 否 | 见描述 | 当为1 或 true时，可以返回 char_pos 字段, 保存了每一行的位置信息。默认关闭 |
| page_details | integer | 否 | 见描述 | 当为1 或 true时，可以返回 pages 字段, 保存了每一页更加详细的解析结果。默认打开 |
| catalog_details | integer | 否 | 见描述 | 当为1 或 true时，可以返回 catalog details |
| dpi | integer | 否 | 见描述 | pdf文档的坐标基准,默认144 dpi。 当parse_mode=auto时，默认动态，支持72，144，216； 当parse_mode=scan时，默认144，支持72，144，216； |
| page_start | integer | 否 | 见描述 | 当上传的是pdf时，page_start 表示从第几页开始转 |
| page_count | integer | 否 | 见描述 | 当上传的是pdf时，page_count 表示要进行转换的pdf页数。 总页数不得超过1000页，默认为1000页 |
| apply_document_tree | integer | 否 | 见描述 | 是否生成标题，默认为1，生成标题0 不生成1 生成标题 |
| markdown_details | integer | 否 | 见描述 | 是否生成markdown details，默认为1，生成markdown details0 不生成1 生成 |
| table_flavor | string | 否 | 见描述 | markdown里的表格格式，默认为html，按html语法输出表格md 按md语法输出表格html 按html语法输出表格 |
| get_image | string | 否 | 见描述 | 获取markdown里的图片，默认为none，不返回任何图像none 不返回任何图像page 返回每一页的整页图像objects 返回页面内的图像对象both 返回整页图像和图像对象 |
| image_output_type | string | 否 | 见描述 | 指定引擎返回的图片对象输出类型，默认返回子图片url和页图片idbase64str 指定所有图片对象为base64字符串，适用于没有云存储的用户，但是引擎返回结果体积会很大default 指定子图片对象为图片url,页图片对象为图片id |
| parse_mode | string | 否 | 见描述 | PDF解析模式，默认为scan模式，仅按文字识别方式处理。图片不用设置，均按文字识别方式处理。auto 综合文字识别和解析模式scan 仅按文字识别模式 |
请求体说明（Request Body）
Content-Type: application/octet-stream
支持的文件格式：png, jpg, jpeg, pdf, bmp, tiff, webp, doc, docx, html, mhtml
请注意，请求体的数据格式为文件的二进制流，非 FormData 或其他格式。文件大小不超过 500M，图像宽高须介于 20 和 10000（像素）之间。
请求
curl --location --request POST 'https://api.textin.com/ai/service/v1/pdf_to_markdown' \
--header 'x-ti-app-id: c81f*************************e9ff' \
--header 'x-ti-secret-code: 5508***********************1c17' \
--data-binary '@/path/to/example.pdf'响应
{
"code":200,
"message":"success",
"result":{
"total_page_number":10,
"document_type":"pdf",
"valid_page_number":3,
"paragraph_number":18,
"character_number":3280,
"pages":[
{
"status":"success",
"page_id":0,
"durations":612.5,
"image_id":"90u12adcad08r2",
"width":0,
"height":0,
"angle":0,
"content":[]
"structured":[]
}
]
"detail":[
{
"page_id":1,
"paragraph_id":0,
"outline_level":-1,
"text":"hellomarkdown",
"type":"paragraph",
"image_url":"string",
"content":0,
"position":[]
}
]
"markdown":"#hellomarkdown"
}
"version":"2.1.0",
"duration":999,
"metrics":[
{
"page_image_width":1024,
"page_image_height":768,
"dpi":72,
"durations":0,
"status":"string",
"page_id":0,
"angle":90,
"image_id":"string"
}
]
}4. 常见问题
Q：如何找到TextIn API开放平台
A：幂简集成是国内领先的API集成管理平台，专注于为开发者提供全面、高效、易用的API集成解决方案。幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’TextIn API开放平台‘这类品类词，更容易找到结果)、或者从API hub分类页进入寻找。
Q：为什么要开启临时存储服务？
A：
TextIn服务器默认 不储存 您上传的任何文件。
使用机器人时，上传的文件仅展示在您的本地列表中，关闭或刷新页面后，文件将会被清空。
如果您想保留您的上传文件，开启储存服务可对在线批量使用的上传历史文件进行再次查看/编辑/导出识别结果，同时查看历史文件。
Q：为什么要设置IP白名单？
A：设置IP白名单后，系统仅允许白名单内的IP进行服务调用，非白名单内的IP访问将被拒绝；不设置白名单则不对请求IP进行检查。
Q：计费与付费？
A：
- 对于免费测试资源未使用完毕的接口服务，开通付费后，先使用免费测试资源中的调用额度，使用完毕后优先抵扣次数包额度，抵扣完毕才根据调用量进行扣费。
- 一旦开通机器人，平台将自动为您开通按量付费方式，无需您手动开通或同意。
Q：身份证OCR是如何收费的?
A：按调用接口成功次数收费，如果识别身份证的正面和反面，则各调用1次，共计费2次，具体价格可查看 「Textin产品计费文档」。
Q：套餐开通后是否支持退款？
A：不支持退款。
除了TextIn API开放平台，还有其他替代服务商也提供类似api服务，例如：
译图智讯 API开放平台、合合信息 API开放平台、小花儿人工智能 API开放平台
更多竞品可以在幂简集成开放平台中找到。
Q：TextIn API开放平台这个密钥还适用于哪些api？
5. 总结
本文全面且细致地介绍了如何获取合合TextIn API开放平台密钥的分步指南，为开发者们提供了一份条理清晰、操作简便的实用手册。从合合TextIn API平台的账号注册，到完成开发者身份验证，再到最终成功获取API密钥，每一步操作都配以详尽的说明与指导，确保开发者能够轻松、准确地完成整个流程。获取密钥只是利用合合TextIn API的第一步，如何高效、稳定地集成并应用其提供的强大文本处理能力才是关键。因此，建议开发者在获取密钥后，进行相应的可用性测试，确保API能够顺利集成到应用中并发挥出最佳效果。本文为开发者们提供了一个全面、详尽且极具实用性的操作指南，帮助他们顺利获取合合TextIn API开放平台的密钥，并将这一强大的文本处理能力有效地集成到应用中。我们相信，随着开发者们对这一指南的深入理解和实践，将能够在应用开发中取得更加显著的成果，为应用的智能化、高效化发展注入新的活力，进而提升应用的性能和用户体验，为用户带来更加智能、便捷的文本处理服务。
