鍵.png)
使用這些基本 REST API 最佳實(shí)踐構(gòu)建出色的 API
在工作臺總覽頁面中，右側(cè)用戶信息最下方可查看您的app-id。
或在工作臺中選擇左側(cè)菜單欄中“賬號管理”頁面，在“開發(fā)者信息”欄中即可獲取。
https://api.textin.com/ai/service/v1/pdf_to_markdown
HTTP POST
請?jiān)贖TTP請求中添加以下自定義標(biāo)頭（Header）。
| header 名 | 值 |
|---|---|
| x-ti-app-id | 請登錄后前往 “工作臺-賬號設(shè)置-開發(fā)者信息” 查看 x-ti-app-id |
| x-ti-secret-code | 請登錄后前往 “工作臺-賬號設(shè)置-開發(fā)者信息” 查看 x-ti-secret-code |
URL參數(shù)指以
{參數(shù)名}={參數(shù)值} 形式拼接到 URL 上的鍵值對。它以?開頭，不同參數(shù)之間使用&連接。形如?p1=v1&p2=v2
| 參數(shù)名 | 數(shù)據(jù)類型 | 是否必填 | 允許的值 | 描述 |
|---|---|---|---|---|
| pdf_pwd | string | 否 | 見描述 | 當(dāng)pdf為加密文檔時(shí)，需要提供密碼。 備注：對前端封裝該接口時(shí)，需要自行對密碼進(jìn)行安全防護(hù) |
| char_details | integer | 否 | 見描述 | 當(dāng)為1 或 true時(shí)，可以返回 char_pos 字段, 保存了每一行的位置信息。默認(rèn)關(guān)閉 |
| page_details | integer | 否 | 見描述 | 當(dāng)為1 或 true時(shí)，可以返回 pages 字段, 保存了每一頁更加詳細(xì)的解析結(jié)果。默認(rèn)打開 |
| catalog_details | integer | 否 | 見描述 | 當(dāng)為1 或 true時(shí)，可以返回 catalog details |
| dpi | integer | 否 | 見描述 | pdf文檔的坐標(biāo)基準(zhǔn),默認(rèn)144 dpi。 當(dāng)parse_mode=auto時(shí)，默認(rèn)動態(tài)，支持72，144，216； 當(dāng)parse_mode=scan時(shí)，默認(rèn)144，支持72，144，216； |
| page_start | integer | 否 | 見描述 | 當(dāng)上傳的是pdf時(shí)，page_start 表示從第幾頁開始轉(zhuǎn) |
| page_count | integer | 否 | 見描述 | 當(dāng)上傳的是pdf時(shí)，page_count 表示要進(jìn)行轉(zhuǎn)換的pdf頁數(shù)。 總頁數(shù)不得超過1000頁，默認(rèn)為1000頁 |
| apply_document_tree | integer | 否 | 見描述 | 是否生成標(biāo)題，默認(rèn)為1，生成標(biāo)題0 不生成1 生成標(biāo)題 |
| markdown_details | integer | 否 | 見描述 | 是否生成markdown details，默認(rèn)為1，生成markdown details0 不生成1 生成 |
| table_flavor | string | 否 | 見描述 | markdown里的表格格式，默認(rèn)為html，按html語法輸出表格md 按md語法輸出表格html 按html語法輸出表格 |
| get_image | string | 否 | 見描述 | 獲取markdown里的圖片，默認(rèn)為none，不返回任何圖像none 不返回任何圖像page 返回每一頁的整頁圖像objects 返回頁面內(nèi)的圖像對象both 返回整頁圖像和圖像對象 |
| image_output_type | string | 否 | 見描述 | 指定引擎返回的圖片對象輸出類型，默認(rèn)返回子圖片url和頁圖片idbase64str 指定所有圖片對象為base64字符串，適用于沒有云存儲的用戶，但是引擎返回結(jié)果體積會很大default 指定子圖片對象為圖片url,頁圖片對象為圖片id |
| parse_mode | string | 否 | 見描述 | PDF解析模式，默認(rèn)為scan模式，僅按文字識別方式處理。圖片不用設(shè)置，均按文字識別方式處理。auto 綜合文字識別和解析模式scan 僅按文字識別模式 |
Content-Type: application/octet-stream
支持的文件格式：png, jpg, jpeg, pdf, bmp, tiff, webp, doc, docx, html, mhtml
請注意，請求體的數(shù)據(jù)格式為文件的二進(jìn)制流，非 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：冪簡集成是國內(nèi)領(lǐng)先的API集成管理平臺，專注于為開發(fā)者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API：通過關(guān)鍵詞搜索API(例如，輸入’TextIn API開放平臺‘這類品類詞，更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
Q：為什么要開啟臨時(shí)存儲服務(wù)？
A：
TextIn服務(wù)器默認(rèn) 不儲存 您上傳的任何文件。
使用機(jī)器人時(shí)，上傳的文件僅展示在您的本地列表中，關(guān)閉或刷新頁面后，文件將會被清空。
如果您想保留您的上傳文件，開啟儲存服務(wù)可對在線批量使用的上傳歷史文件進(jìn)行再次查看/編輯/導(dǎo)出識別結(jié)果，同時(shí)查看歷史文件。
Q：為什么要設(shè)置IP白名單？
A：設(shè)置IP白名單后，系統(tǒng)僅允許白名單內(nèi)的IP進(jìn)行服務(wù)調(diào)用，非白名單內(nèi)的IP訪問將被拒絕；不設(shè)置白名單則不對請求IP進(jìn)行檢查。
Q：計(jì)費(fèi)與付費(fèi)？
A：
Q：身份證OCR是如何收費(fèi)的?
A：按調(diào)用接口成功次數(shù)收費(fèi)，如果識別身份證的正面和反面，則各調(diào)用1次，共計(jì)費(fèi)2次，具體價(jià)格可查看?「Textin產(chǎn)品計(jì)費(fèi)文檔」。
Q：套餐開通后是否支持退款？
A：不支持退款。
除了TextIn API開放平臺，還有其他替代服務(wù)商也提供類似api服務(wù)，例如：
譯圖智訊 API開放平臺、合合信息 API開放平臺、小花兒人工智能 API開放平臺
更多競品可以在冪簡集成開放平臺中找到。
Q：TextIn API開放平臺這個密鑰還適用于哪些api？
本文全面且細(xì)致地介紹了如何獲取合合TextIn API開放平臺密鑰的分步指南，為開發(fā)者們提供了一份條理清晰、操作簡便的實(shí)用手冊。從合合TextIn API平臺的賬號注冊，到完成開發(fā)者身份驗(yàn)證，再到最終成功獲取API密鑰，每一步操作都配以詳盡的說明與指導(dǎo)，確保開發(fā)者能夠輕松、準(zhǔn)確地完成整個流程。獲取密鑰只是利用合合TextIn API的第一步，如何高效、穩(wěn)定地集成并應(yīng)用其提供的強(qiáng)大文本處理能力才是關(guān)鍵。因此，建議開發(fā)者在獲取密鑰后，進(jìn)行相應(yīng)的可用性測試，確保API能夠順利集成到應(yīng)用中并發(fā)揮出最佳效果。本文為開發(fā)者們提供了一個全面、詳盡且極具實(shí)用性的操作指南，幫助他們順利獲取合合TextIn API開放平臺的密鑰，并將這一強(qiáng)大的文本處理能力有效地集成到應(yīng)用中。我們相信，隨著開發(fā)者們對這一指南的深入理解和實(shí)踐，將能夠在應(yīng)用開發(fā)中取得更加顯著的成果，為應(yīng)用的智能化、高效化發(fā)展注入新的活力，進(jìn)而提升應(yīng)用的性能和用戶體驗(yàn)，為用戶帶來更加智能、便捷的文本處理服務(wù)。