Specification for Reader OCR Service

Check out the specification below to see how easy it is to integrate OCR into your solutions.

Specification

Each request to a feedzon web service requires a number of parameters, all listed below. All requests require an Service Key which was generated when you activated a key for that service. You can create multiple keys for each service, if required.

feedzon methods and parameters names are all case sensitive,e.g. UploadFile will work but uploadFile will not; ServiceKey=abc123 will work and SERVICEKEY=abc123 will not.

Upload File

Upload a file to the Reader service for technologies that enable you to encode the binary file to Base64 and perform an HTTP Post. Currently only supports the 'businesscard' input format; we will shortly add support for the 'image' (documents) input format.

Request Format

https://api.feedzon.com/reader/1.1/UploadFile.fz?{parameters}

Returns

"0"
"123456"

Parameters

Name Type Description Example
ServiceKey String Your Service Key 1b6e9c89053a651b68eb41d0e8c6c692
Input String Use one of the following: image (for single or multi-page documents) or businesscard (for business card conversion). image
Output String Required output file type. Use one of the following: docx, doc, xlsx, xls, pptx, pdfsearchable, pdftextandimages, pdfa, rtf, txt, txtcolumn docx
Language String feedzon recognised language code for the text. If your document contains multiple languages, simply provide each language separated by a comma. engl
Reference String Optional personal reference, e.g. a Job ID from your database My reference
File String Base 64 encoded image file c3VyZS4...

Maximum file size is 20 Mb.

Get Task Status

Get the status of one or more tasks.

Request Format

https://api.feedzon.com/reader/v1/GetTaskStatus.fz?{parameters}

Returns

"0"
"121","0"
"122","0"
"123","1"

Parameters

Name Type Description Example
ServiceKey String Your Service Key 1b6e9c89053a651b68eb41d0e8c6c692
TaskId (optional) String Zero or more TaskIds (see notes below) 6789

Specify zero or more Task Ids. If no TaskIds are specified, feedzon returns the status of up to the 100 most recently processed tasks using the reader service. If you specify a single TaskId, e.g. TaskId=123, the status for just that TaskId will be returned. Alternatively specify multiple TaskIds, e.g. TaskId=121,122,123, in which case the status for each specified TaskId will be returned on a separate line.

Returned status are:
1 = TaskId not recognised
3 = Processing
4 = Failed processing, e.g. no text could be identified in the supplied image
5 = Ready to download
6 = Already downloaded (and deleted from the feedzon servers)

Download File

Download the results as file.

Request Format

https://api.feedzon.com/reader/1.1/DownloadFile.fz?{parameters}

Parameters

Name Type Description Example
ServiceKey String Your Service Key 1b6e9c89053a651b68eb41d0e8c6c692
TaskId String TaskId provided when using UploadFile method 6789

In FileMaker the results should be saved to a container field.

Download Text

Download the results as text.

Request Format

https://api.feedzon.com/reader/1.1/DownloadText.fz?{parameters}

Parameters

Name Type Description Example
ServiceKey String Your Service Key 1b6e9c89053a651b68eb41d0e8c6c692
TaskId String TaskId provided when using UploadFile method 6789

In FileMaker the results should be saved to a text field.

vCard

Download the results as vCard (.vcf).

Request Format

https://api.feedzon.com/reader/1.1/vCard.fz?{parameters}

Parameters

Name Type Description Example
FirstName String First Name to be used James
MiddleName String Middle Name to be used William
LastName String Last Name to be used Smith
Company String Company name to be used James W. Smith Consultancy
Job String Job title to be used Director
JobDepartment String Job Department to be used Management
Phone String Phone to be used 6789
Mobile String Mobile number to be used 07510165454
Fax String Fax number to be used 01493 393411
Email String Email address to be used james.w.smith@jws-consultancy.uk
Web String Web address to be used www.jws-consultancy.uk
StreetAddress String Street Address to be used 24 Carmichael Road
City String City to be used London
ZipCode String Zip Code to be used SE24 4LT
Country String Country to be used United Kingdom
Note String Note to be displayed Business exhibition, March 2015

In FileMaker the results should be saved to a container field.

Response Errors

 

Error Description Cause Resolution
-1 Function doesn't exist The function name doesn't exist or has been spelled incorrectly. Please check your syntax for any errors since all function names and parameter names are case sensitive.
1000 Service Key is invalid The Service Key used to access feedzon was not recognised or has been disabled. Please check your Service Key, re-enable the application or contact us for further assistance.
1010 Missing parameters One or more parameters are missing Please check the parameters section to identify which parameters are required for the specified command.
1020 File or text does not exist The file or text result does not exist Once a result has been downloaded it is immediately deleted from feedzon servers and you cannot download it again.
1030 Language specification error One or more of the specified languages was not recognised Click here to see the feedzon language codes and ensure your parameters reference only recognised language codes.
2000 Account credit error Your feedzon account is out of credit or does not have sufficient credits remaining for the requested service. Please login to your feedzon account and purchase additional credits. Also consider adding an auto top-up to avoid this problem in the future.