Table of Contents
Step 1: Download
Click on the link below to download the .NET version of the API (v1.12.4) as a dll.
Step 2: Create Your First Job
Follow the steps below to set up your first crawl job through the API. Sample code for doing this can be found in the Sample Code section.
1. Download the 80legs API dll and place it in your application's class path.
2. Instantiate an instance of APIProfile and set the following parameters:
VersionId - Set to "1.0".
ApiToken - Set this to the value you obtained from the web portal after following the instructions in the Getting Started section.
Example:
APIProfile profile = new APIProfile();
profile.Version ="1.0";
profile.ApiToken = "[Your API Security Token]";
3. Instantiate an instance of EightyLegsConnector using the APIProfile as the parameter.
Example:
IEightyLegsConnector connector = new EightyLegsConnector(profile);
4. Use the EightyLegsConnector methods to create jobs, retrieve jobs and call other methods specified in the next section.
Complete sample code for doing the above can be found in the Sample Code section.
API Methods
Important: The .NET API does not provide access to Post Processing methods.
The following methods are available from the API:
| Category |
Method
|
Response |
Description
|
| Job Methods |
CreateJob |
int JobID |
Creates a job in 80legs. |
| DeleteJob |
N/A |
Deletes the job identified by the given job ID. |
| CancelJob |
N/A |
Cancels the job identified by the given job ID. |
| CopyJob |
int JobID |
Copies an existing job that is identified by the given job ID. The new job is created with the specfied job name.
|
| RetrieveJobs |
IList<JobSummary> |
Retrieves all jobs with the given status. |
| RetrieveJobSetting |
JobSetting |
Retrieves the job settings that were used to create the job. |
| RetrieveJobOverview |
JobOverview |
Retrieves the overview information that is related to the job. This includes job status as well as the latest job queue status. |
| RetrieveJobRuns |
IList<JobRun> |
Retrieves information for all runs for the given job. This includes the results of those runs as well. |
| RetrieveRunResultInfo |
IList<RunResult> |
Retrieves the run result information for the job run identified by the given ID. This information includes fields such as the name of the file and the type of the file.
|
| DownloadResult |
String Filename |
Downloads the result file and saves the file at the specified path. |
| DownloadResults |
IList<String> |
Downloads the result file specified by the RunResult list parameter and saves the file at the specified path. Note: Can be used to download regular jobs or crawl package jobs.
|
| Code Methods |
UploadCode |
int CodeID |
Uploads the code identified by the file and gives the filename that is used to identify the file. |
| RetrieveCodeByUser |
IList<CodeFile> |
Retrieves all code information for the given user. |
| RetrieveCodeByID |
CodeFile |
Retrieves a code information that is identified by the code ID. |
| DownloadCode |
String Filename |
Downloads the code identified by the code ID to the file location provided by the file Path and names it with the given file name. |
| DeleteCode |
N/A |
Deletes the code that is identified by the given ID. |
| Data Methods |
UploadData |
int DataID |
Uploads the data identified by the file and uses the data name to identify the data. |
| RetrieveDataByUser |
IList<DataFile> |
Retrieves all the data file information pertaining to the user. |
| RetrieveDataByID |
DataFile |
Retrieves the data information associated to the data identified by the ID. |
| DownloadData |
String Filename |
Downloads data identified by the given ID. |
| DeleteData |
N/A |
Deletes the data file identified by the given ID. |
| Seed List Methods |
UploadSeedList |
int SeedlistID |
Uploads the seed list file and provides the file name that is used to identify the file.
New overloaded method!!!
An overloaded method has been added which requires another parameter for validation messages. The method signature is: UploadSeedList(FileInfo file, String seedListName, bool ignoreBadURLs, String ignoreBadUrlMessage). If ignoreBadURLs is set to true and there are any urls that are bad, the seedlist will be added and the message of the bad urls will be returned in the ignoreBadUrlMessage string.
|
| RetrieveSeedListByUser |
IList<SeedlistFile> |
Retrieves all the seed list files information pertaining to the user. |
| RetrieveSeedListByID |
SeedlistFile |
Retrieves seed list file information that is identified by the given ID. |
| DownloadSeedList |
String Filename |
Allows for downloading of seed list that is identified by the seed list ID. |
| DeleteSeedList |
N/A |
Deletes the seed list identified by the ID.
|
| Account Methods |
RetrieveAccountBalance |
AccountBalance |
Retrieves the user account balance information. |
| |
RetrieveUserInformation |
User |
Retrieves the user information. |
|
EightyApp (80app) methods
|
RetrieveEightyAppById(int) |
EightyApp |
Retrieves EightyApp information that is identified by the given 80app Id. Provides the latest version that is public for the 80app. |
| |
RetrieveEightyAppByVersionId |
EightyApp |
Retrieves EightyApp information that is identified by the given versionId. The EightyApp object has the version that is associated with the versionId. |
| |
GetEightyAppVersionsInActiveJobsForUser |
IList<EightyApp> |
Retrieves the EightyApp with version that are available to the users and have not expired. |
|
Crawl Package (v.1.9.0)
|
DownloadResultsByCrawlPackage |
String |
Downloads the result file at the given path and saves it using the job result name. The job can be from the crawl package. |
| |
RetrieveJobRunsForCrawlPackage |
IList<JobRun> |
Retrieves all the job run information for the given job Id and crawl package Id. |
| |
RetrieveJobsForCrawlPackage |
IList<JobSummary> |
Retrieves all the job that are identified by the given status. If status is not provided and is null, all jobs are retrieved for the user.
|
|
Crawl Package Archived Jobs data
(New v: 1.11.0)
|
RetrieveCrawlPackageArchivedJobs |
IList<JobSummary> |
Retrieves all the crawl package archived jobs for the user.
|
| |
RetrieveJobOverviewForArchivedJob |
JobOverview |
Retrieves the overview information that is related to the crawl package archvied job.
|
| |
RetrieveJobRunsForCrawlPackageArchivedJob |
IList<JobRun> |
Retrieves all the job run information for the given archived job Id.
|
| |
RetrieveRunResultsInfoForAllNewResultsForCrawlPackageArchivedJobs |
IList<RunResult> |
Retrieves the run result information for all results that have not been downloaded by the current user that are archived job results. |
Check out the Sample Code for samples on how to use the API.
Check out the FAQ for answers to a wide variety of questions.
Changelog
80legs periodically updates the API in order to deliver new features and to repair defects discovered in previous versions. In most cases, these changes will be transparent to API developers. However, occasionally we need to make changes that require developers to modify their existing applications. This page documents any changes made to the API that may effect your application. We recommend that API developers periodically check this list for any new announcements.
Version
|
Release Date
|
Description |
|
|
Initial Release |
| 1.0.6 |
|
API specific exceptions now have a common parent class EightyLegsCommonException |
1.0.7
|
7/20/2010
|
New Feature:
- Added access to eighty app, eighty app version and crawl package.
|
| 1.8.0 |
8/19/2010
|
New Feature
- 8/19/2010: Added new option in OutgoingLinkType of LINKS_FROM_SAME_FULLY_QUALIFIED_DOMAIN_WITH_RESTRICTED_HOST.
Bug Fixes:
- 8/1/2010Modified DownloadResultFile method which was throwing an object reference not set to an object error.
|
| 1.9.0 |
8/26/2010 |
New Feature:
- Added new field in job Runs called IsDoneResultPosting. If this is set to 1, no more results will be available for the job run. (Note: if you downloaded the dll before 8/26/2010, you may have an older version. Please download again.)
|
| 1.10.0 |
1/5/2010 |
Bug Fix:
- Fixed a bug in Customer Result class where an Argument Exception was being thrown if the url was being repeated twice. This is rare, but it could happen.
|
| 1.11.0 |
1/26/2011
|
New Feature:
- Added capability to retrieve crawl package archived jobs and their results.
|
| 1.12.0 |
2/6/2011 |
Bug Fix:
- Fix a header problem which was as a result of us switching to a new server.
|
| 1.12.4 |
6/23/2011 |
Bug Fix:
- Fixed a problem when the read size is not being sent when the responses are chunked from the server.
|
Last Updated
The API was last updated on June 23, 2011
Comments (0)
You don't have permission to comment on this page.