public final class ArcherAPIWrapper extends AbstractAPIWrapper
Provides access to the Veracode Archer API. The Archer dashboard is a platform for governance, risk, and compliance solutions that consumes XML data feeds to integrate data from a variety of sources into a unified view of enterprise-wide risk. Veracode provides Archer feeds that include information about the applications in an account. For assessments of internally developed or maintained applications, a feed includes scores, a listing of all discovered flaws, and status information about the flaws (new, open, fixed, or re-opened). Summary data is included for third-party assessments, including scores and top-risk categories. Customers who have purchased a subscription that includes access to the Archer API can generate and retrieve Archer reports.
To be able to access the Archer API, you must have a non-human API customer account that has the Archer API role.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ARCHER_URI |
static java.lang.String |
DOWNLOAD_ARCHER_REPORT_URI |
static java.lang.String |
DOWNLOAD_FLAW_REPORT_URI |
static java.lang.String |
GENERATE_ARCHER_REPORT_URI |
static java.lang.String |
GENERATE_FLAW_REPORT_URI |
BASE_ADDRESS
Constructor and Description |
---|
ArcherAPIWrapper() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
archer()
The Archer is the deprecated call that pushes the Archer feed to an XML
report.
|
java.lang.String |
archer(java.lang.String app_id,
java.lang.String period,
java.lang.String from_date,
java.lang.String to_date,
java.lang.String scan_type)
The Archer is the deprecated call that pushes the Archer feed to an XML
report.
|
java.lang.String |
downloadArcherReport()
Returns the Archer XML report when its generation is complete.
|
java.lang.String |
downloadArcherReport(java.lang.String token)
Returns the Archer XML report when its generation is complete.
|
java.lang.String |
downloadFlawReport() |
java.lang.String |
downloadFlawReport(java.lang.String token) |
java.lang.String |
generateArcherReport()
Initiates the process of generating the Archer report, which contains a
token you use to retrieve the report when the processing is complete.
|
java.lang.String |
generateArcherReport(java.lang.String app_id,
java.lang.String period,
java.lang.String from_date,
java.lang.String to_date,
java.lang.String scan_type)
Initiates the process of generating the Archer report, which contains a
token you use to retrieve the report when the processing is complete.
|
java.lang.String |
generateFlawReport()
Creates an XML report that lists all fixed and unfixed flaws for the specified application(s) and/or scan type.
|
java.lang.String |
generateFlawReport(java.lang.String app_id_list,
java.lang.String scan_type)
Creates an XML report that lists all fixed and unfixed flaws for the specified application(s) and/or scan type.
|
setUpApiCredentials, setUpCredentials, setUpProxy, setUpProxy, setUpProxy
public static final java.lang.String ARCHER_URI
public static final java.lang.String GENERATE_ARCHER_REPORT_URI
public static final java.lang.String DOWNLOAD_ARCHER_REPORT_URI
public static final java.lang.String GENERATE_FLAW_REPORT_URI
public static final java.lang.String DOWNLOAD_FLAW_REPORT_URI
public java.lang.String archer() throws java.io.IOException
The Archer is the deprecated call that pushes the Archer feed to an XML report.
Calls this URL: https://analysiscenter.veracode.com/api/archer.do Schema File: XSD schema file from archer-tech.com/
java.io.IOException
public java.lang.String archer(java.lang.String app_id, java.lang.String period, java.lang.String from_date, java.lang.String to_date, java.lang.String scan_type) throws java.io.IOException
The Archer is the deprecated call that pushes the Archer feed to an XML report.
Calls this URL: https://analysiscenter.veracode.com/api/archer.do Schema File: XSD schema file from archer-tech.com/
app_id
- The application ID of the application for which you wish to
pull data. You can find the application ID in the main Archer
feed or by using the Results API.period
- Use a time period: yesterday, last week (preceding Saturday to
Sunday), last month (preceding calendar month). Using the
period option selects any published applications that have had
modifications (either published or mitigated) during the
specified time period.from_date
- Specify the beginning of a date range using a dd-mm-yyyy
format. Should be used with the to_date parameter.to_date
- Specify the end of a date range using dd-mm-yyyy format.
Should be used with the from_date parameter.scan_type
- Specify one of the following flaw types: static, dynamic,
manualjava.io.IOException
public java.lang.String generateArcherReport() throws java.io.IOException
Initiates the process of generating the Archer report, which contains a token you use to retrieve the report when the processing is complete.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/generatearcherreport.do Schema File: https://analysiscenter.veracode.com/resource/1.0/archerreportrequest.xsd
java.io.IOException
public java.lang.String generateArcherReport(java.lang.String app_id, java.lang.String period, java.lang.String from_date, java.lang.String to_date, java.lang.String scan_type) throws java.io.IOException
Initiates the process of generating the Archer report, which contains a token you use to retrieve the report when the processing is complete.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/generatearcherreport.do Schema File: https://analysiscenter.veracode.com/resource/1.0/archerreportrequest.xsd
app_id
- A String that represents an Integer value. The application ID
of the application for which you wish to pull data. You can
find the application ID in the main Archer feed or by using
the Results API.period
- Use a time period: yesterday, last_week (preceding Saturday to
Sunday), last_month (preceding calendar month). Using the
period option selects any published applications that have had
modifications (either published or mitigated) during the
specified time period.from_date
- Specify the beginning of a date range using a dd-mm-yyyy
format. Should be used with the to_date parameter.to_date
- Specify the end of a date range using dd-mm-yyyy format.
Should be used with the from_date parameter.scan_type
- Specify one of the following flaw types: static, dynamic,
manualjava.io.IOException
public java.lang.String downloadArcherReport() throws java.io.IOException
Returns the Archer XML report when its generation is complete.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/downloadarcherreport.do Schema File: XSD schema file from archer-tech.com/
java.io.IOException
public java.lang.String downloadArcherReport(java.lang.String token) throws java.io.IOException
Returns the Archer XML report when its generation is complete.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/downloadarcherreport.do Schema File: XSD schema file from archer-tech.com/
token
- A string contained in the archer.xml file returned by the
generatearcherreport.do call.java.io.IOException
public java.lang.String generateFlawReport() throws java.io.IOException
java.io.IOException
public java.lang.String generateFlawReport(java.lang.String app_id_list, java.lang.String scan_type) throws java.io.IOException
app_id_list
- Optional. CSV list of app idsscan_type
- Optional: static, dynamic, or manualjava.io.IOException
public java.lang.String downloadFlawReport() throws java.io.IOException
java.io.IOException
public java.lang.String downloadFlawReport(java.lang.String token) throws java.io.IOException
token
- Optional. You obtain this token from the XML report returned by calling generateflawreport.do.java.io.IOException