Getting Started with the Interzoid Text File Batch Tool
Quickly and easily improve the quality, accuracy, usability, and value of your important data assets
1Obtain an API Key
To begin, you must obtain an Interzoid API key. Log in to your account or register for one at www.interzoid.com. Once registered, your API key will be used to authenticate each API call and for keeping track of usage.
2Select API to Use
Choose the API in the left-hand column that will be used for the processing of the text file. The selected API will be called for each record/line in the text file, the output of which will be included in the results. The API will be called using our parallel-processing batch platform for maximum performance.
3Configure Settings for Job
The tool allows you to choose between two File Source input modes: Local File (default) and Web URL. In Local File mode, you can upload a file from your computer that will be used for processing. In Web URL mode, simply enter the direct URL to your file. In this case, ensure that the text file is a raw text file and does not include any embedded HTML. If using a local file, click "Choose Input File..." to browse for the text file on your device that will be used for processing.
You can also select the Input File Format (CSV or TSV). TSV (tab-delimited) files are recommended to help avoid the extraneous comma challenges that improperly formatted CSV (comma-delimited) files sometimes cause (see note below).
You must also specify the Column Number. This is the number of the column in the text file (starting from the left and beginning with #1) that will be used to call the API to process each record in the file. For example, when generating organization similarity keys, this column would be the organization name that will be used as the basis for generating the similarity key for matching with other organization names. For the Global Weather API for example, this column is the location in the world to find the current weather for. For the Email Information API, this column would contain the email address to use for the basis of the email lookup, and so on. For a given API, there may be additional fields to enter that will be part of each API call. In these cases, a default value is provided.
If you check the Show All option, an extra parameter (showall=true
) is added to the batch API call. This indicates that all fields from the
input file will also appear in the output file, along with all the data appended to each line resulting from the output of each API call. If unchecked,
all the data corresponding to the selected "column number" will be included with the output data.
4Run the Job
Once you have entered your API key and configured the settings, click the Run button (with its action icon) to execute API calls for each line in the input file. A spinner will indicate that the job is processing, and the API responses for each line will be displayed in the results window.
5Review and Download Results
The output is shown in a dedicated results window that supports horizontal scrolling for long output. You can review the results and click the Download button to save the output file for additional use.
Note: Be sure to have your files in the proper standard format required for CSV and TSV files.
CSV Text Qualifiers: If any of your data field values contain the delimiter character of a comma, you should enclose that particular field in double quotes (e.g., “John, Doe, Inc.”) per industry standards. This ensures that the delimiter inside the quotes is treated as part of the data rather than a separator, which could otherwise cause issues reading data. Export functions of various applications will typically enforce this format. If you are running a file with only a single column of input data, the TSV format is recommended since the entire line will be read as a column, avoiding the issue of unquoted data that contains commas.
Need help? Contact support@interzoid.com for assistance. Try the APIs interactively at this link.
Congratulations! You are now ready to use the Interzoid Text File Batch Tool to improve the quality, consistency, usability, and value of your important data assets.