cvparsing developers api documentaion
 DocBurnLogo
Get
 doc2PDF
Get
 doc2Clean
Get
 doc2image
Get
 docMerge
Get
 docHub
Get
 docEdit
Post
 Html2Doc
Get
 Doc2Html
Get
 Doc2Text
Get
 cvParsing
Get

POST Burn Logo Image on word document header section
https://cvparsing.ze.io/api/public/docBurnLogo/v2/
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
binFile
required
BinaryFile 
htmlCodeText
required

text 
logoBinFile
required

BinaryFileLogo to burn MultiPart Binary file
logoUrl
required

text Logo to burn url address
Response
200: OK
Binary File  

 
POST Convert word document files to PDF files
https://cvparsing.ze.io/api/public/doc2Pdf/v1/
Request
Form Parameters Type Description
tokenId
required
text Access token of this project
file1
required
BinaryFile  
Response
200: OK
Binary File  PDF  
 
 
POST Clean word Document and Pdf files from key words
https://cvparsing.ze.io/api/public/doc2Clean/v2/
Request
Form Parameters Type Description
tokenId
required
text Access token of this project
file1
required
BinaryFile  docx , doc , pdf files
categories2Clean
optional
array parameter to pass:
id
firstName 
city
phone
email
url


if empty, the api will clean (phone , email , id ,url)
freeText
optional
string Clears one word or sentence, devide words by comma
Response
200: OK
Binary File    
 
 
POST create word documnet , insert the image uploded
https://cvparsing.ze.io/api/public/doc2Clean/v1/
Request
Form Parameters Type Description
tokenId
required
text Access token of this project
file1
required
BinaryFile  image Files Type (jpeg, jpg, png)
Response
200: OK
Binary File  jpeg  
 
 
POST  Merge group of files to single file
https://cvparsing.ze.io/api/public/docMarge/v1/
Request
Form Parameters Type Description
tokenId
required
text Access token of this project
file1
required
BinaryFile  array of files (docx, doc , pdf)
Response
200: OK
Binary File    
 
 
POST Edit docx & Pdf files and merge to one file
https://cvparsing.ze.io/api/public/docHub/v1/
Request
Form Parameters Type Description
tokenId
required
text Access token of this project
file1[N]
required
BinaryFile  file (number inside) (array of binary Files)
htmlCodeText
optional
string HTML
command[apiType][N]
required
Array file order (number inside).
example doc2Clean , doc2Html , docEdit
command[addHeader][N]
optional
Array HTML
command[addFooter][N]
optional
Array HTML
command[cleanFooter][N]
optional
Array true' or ""
command[cleanHeader][N]
optional
Array true' or ""
command[categories2Clean][N]
optional
Array parameter to pass:
id
firstName 
city
phone
email
url
command[categories2Clean][freeText]
optional
String Clears one word or sentence, devide words by comma
afterJoin[apiType][N]
optional
Array file order (number inside).
example doc2Clean , doc2Pdf, docEdit
afterJoin[cleanHeader]
optional
string 'true' or ""
afterJoin[cleanFooter]
optional
string true' or ""
afterJoin[addHeader]
optional
string HTML
afterJoin[addFooter]
optional
string HTML
afterJoin[categories2Clean][N]
optional
Array parameter to pass:
id
firstName 
city
phone
email
url
afterJoin[categories2Clean][freeText]
optional
String Clears one word or sentence, devide words by comma
200: OK
response Binary Binary File
examples  
Array
(
    [file1] => Array
        (
            [name] => Array
                (
                    [0] => file1.docx
                    [1] => TestHtml.html
                )

            [type] => Array
                (
                    [0] => application/vnd.openxmlformats-officedocument.wordprocessingml.document
                    [1] => text/html
                )

            [tmp_name] => Array
                (
                    [0] => C:/Windows/Temp/phpADA6.tmp
                    [1] => C:/Windows/Temp/phpADB6.tmp
                )

            [error] => Array
                (
                    [0] => 0
                    [1] => 0
                )

            [size] => Array
                (
                    [0] => 45019
                    [1] => 157610
                )

        )

)
Array
(
    [htmlCodeText] => 
    [command] => Array
        (
            [apiType] => Array
                (
                    [0] => Array
                        (
                            [0] => docEdit
                            [1] => doc2Clean
                        )

                    [1] => Array
                        (
                            [0] => doc2Clean
                        )

                )

            [cleanHeader] => Array
                (
                    [0] => on
                )

            [cleanFooter] => Array
                (
                    [0] => on
                )

            [addHeader] => Array
                (
                    [0] =>

i am header

                    [1] => 
                )

            [addFooter] => Array
                (
                    [0] =>

I am footer

                    [1] => 
                )

            [categories2Clean] => Array
                (
                    [0] => Array
                        (
                            [0] => firstName
                            [1] => lastName
                            [2] => phone
                            [3] => email
                            [freeText] => example , example 2
                        )

                    [1] => Array
                        (
                            [0] => firstName
                            [1] => lastName
                            [freeText] => 
                        )

                )

        )

    [afterJoin] => Array
        (
            [apiType] => Array
                (
                    [0] => doc2Pdf
                )

            [addHeader] => 
            [addFooter] => 
            [categories2Clean] => Array
                (
                    [freeText] => 
                )

        )

    [tokenId] => XXXXXXXX-XXXX-XXXX-XXXXX-XXXXXXX
)
 
 
POST Edit docx & Pdf single file
https://cvparsing.ze.io/api/public/docHub/v1/
Request
Form Parameters Type Description
tokenId
required
text Access token of this project
file1
required
BinaryFile  file (docx . doc. Pdf)
addHeader
optional
String accept HTML Tags
addFooter
optional
String accept HTML Tags
cleanFooter
optional
String true or "" (Defult is empty string)
cleanHeader
optional
String true or "" (Defult is empty string)
200: OK
Binary File    
 

POST Convert Html to Microsoft word file
https://cvparsing.ze.io/api/public/htmlToDoc/v1/
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
htmlCodeText
required

text 
Response
200: OK
Binary File  


POST Convert Document file to Html code
https://cvparsing.ze.io/api/public/doc2Html/v1/
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
file1
required

BinaryBinary Document File
Response
200: OK
Html
  


POST Convert Document file to Html code
https://cvparsing.ze.io/api/public/doc2text/v1/
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
file1
required

BinaryBinary Document File
Response
200: OK
{
status:OK,
text:"convertedText..."
}
JSON
 


POST Parse new file
https://cvparsing.ze.io/api/public/cvParsing/v1/
Request
Form ParametersTypeDescription
tokenId
required
textAccess token of this project
file1
required

BinaryBinary Document File
Response
200: OK
{
  "curlMessage": "File parsed to HTML successfully",
  "cv":{
   "education" : "all Education text",
   "experience" : {
    "allTextInArray" : "all Experience text",
    "companyName" : "", 
    "duty" : "",
    "fromYear" : "",
    "toYear" :""
    },
   "language" :"",
   "other" : "",
   "personalDetails" :{
     "address" : "hasalom 1",
    "allText":"",
    "allTextInArray" :"",
    "city" : "tel-aviv",
    "email" : "israeli@gmail.com",
    "familyStatus" :"m",
    "familyStatusPlus" :"1",
    "gender" :"male",
    "id": "3020145150",
    "linkedin": "https://www.linkedin.com/in/israel-israeli-b1977056/",
    "name":{
     "firstName" :"israel",
     "fullName" : "israel israeli",
     "lastName" :  "israeli",
    } ,
    "phone":{
     "homePhone" :"",
     "mobile" :  "050-220-3304",
    },
    "txtPersonal" :"all personal details text",
    "year" : "yyyy-mm-dd",
    }
   },
  "responseText": "All The text",
  "status": "OK",
  "uploadedFileName":"1579513791.5481.abc123.docx",
  "uploadedFileSize": "13799"
}

 
 

ze.io