使用這些基本 REST API 最佳實踐構建出色的 API
在工作臺總覽頁面中，右側用戶信息最下方可查看您的app-id。
或在工作臺中選擇左側菜單欄中“賬號管理”頁面，在“開發者信息”欄中即可獲取。
https://api.textin.com/ai/service/v1/pdf_to_markdown
HTTP POST
請在HTTP請求中添加以下自定義標頭（Header）。
| header 名 | 值 |
|---|---|
| x-ti-app-id | 請登錄后前往 “工作臺-賬號設置-開發者信息” 查看 x-ti-app-id |
| x-ti-secret-code | 請登錄后前往 “工作臺-賬號設置-開發者信息” 查看 x-ti-secret-code |
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 僅按文字識別模式 |
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"
}
]
}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？
本文全面且細致地介紹了如何獲取合合TextIn API開放平臺密鑰的分步指南，為開發者們提供了一份條理清晰、操作簡便的實用手冊。從合合TextIn API平臺的賬號注冊，到完成開發者身份驗證，再到最終成功獲取API密鑰，每一步操作都配以詳盡的說明與指導，確保開發者能夠輕松、準確地完成整個流程。獲取密鑰只是利用合合TextIn API的第一步，如何高效、穩定地集成并應用其提供的強大文本處理能力才是關鍵。因此，建議開發者在獲取密鑰后，進行相應的可用性測試，確保API能夠順利集成到應用中并發揮出最佳效果。本文為開發者們提供了一個全面、詳盡且極具實用性的操作指南，幫助他們順利獲取合合TextIn API開放平臺的密鑰，并將這一強大的文本處理能力有效地集成到應用中。我們相信，隨著開發者們對這一指南的深入理解和實踐，將能夠在應用開發中取得更加顯著的成果，為應用的智能化、高效化發展注入新的活力，進而提升應用的性能和用戶體驗，為用戶帶來更加智能、便捷的文本處理服務。