Security-Database API Reference : vDNACPEManagement *
The vDNACPEManagement API consists of individual requests and responses, as shown below.
Endpoint WSDL/XSD
API Production (Live) Endpoint |
---|
https://www.security-database.com/get_vdna_soapserver_cpemanagement.php?wsdl |
SOAP Service Endpoints Limitations
For each Security-Database Web Services API service Endpoints, we limit the query request per module as follow :
Production Web Services API Services Endpoints Queries Limitations | ||
---|---|---|
Free and Business | Enterprise | |
vDNACPEManagement() | N/A | Unlimited queries / day |
vDNACPEManagement API Overview
vDNACPEManagement API Overview by Name
API | Purpose |
---|---|
add_product | Allow to add a new Product or Product/Version to your inventory |
remove_product | Allow to remove a Product or Product/Version from your inventory |
get_inventory | Retreive the list of Product or Product/Version from your inventory |
vDNACPEManagement API Overview by Name and Function
API Overview by Name and Function and Service Endpoint
SOAP Name | SOAP Request / Response |
---|---|
add_product | add_productIn add_productOut |
remove_product | remove_productIn remove_productOut |
get_inventory | get_inventoryIn get_inventoryOut |
add_product
add_productIn is your request to add a new Product or Product/Version to your inventory
add_productIn
vDNACPEManagement API Overview by Field
Element | Description | Data Type | Allowable Values | Required |
---|---|---|---|---|
login | This is your Security-Database User Login | xsd:string | See Description | Yes |
apikey | This is your API Key that you can found in your Security-Database User Panel (menu vDNA API) | xsd:string | 32 single-byte characters | Yes |
modulekey | This is your Module id that you can found in your Security-Database User Panel (menu vDNA API -> modules) | xsd:string | 32 single-byte characters | Yes |
cpeproduct | Your CPE product / Version. Must be CPE compatible : [cC][pP][eE]:/[AHOaho](:[A-Za-z0-9\._\-~%]*){0,6} | xsd:string | See Description | Yes |
cpetype | Specify if the Product is a Full Product (like Mozilla Firefox) '2' or a Product/Version '1' (like Mozilla Firefox 3.6) | xsd:int | 1|2 | Yes |
Example of add_productIn
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:get="https://www.security-database.com/get_vdna_soapserver_cpemanagement.php"> <soapenv:Header/> <soapenv:Body> <get:add_product soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <login xsi:type="xsd:string">testlogin</login> <apikey xsi:type="xsd:string">quJzDo7J5VDAouuNFuVvlDu6dAhlvfxS</apikey> <modulekey xsi:type="xsd:string">65de86d1ksn10odj1u42f4f66885d211</modulekey> <cpeproduct xsi:type="get:CPEproduct">cpe:/a:sun:jre</cpeproduct> <cpetype xsi:type="xsd:string">2</cpetype> </get:add_product> </soapenv:Body> </soapenv:Envelope>
add_productOut
vDNACPEManagement API Overview by Field
Element | Description | Data Type | Possible Values |
---|---|---|---|
return | return "OK" if successfull | xsd:string | See description |
Example of add_productOut
Example of SOAP return. See the third block for the complex XML return with shema validation possibility. Schema available here : https://www.security-database.com/schemas/vdnacpemanagement.xsd
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https//www.security-database.comget_vdna_soapserver_cpemanagement.php" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:add_productResponse> <return xsi:type="xsd:string">OK</return> </ns1:add_productResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
remove_product
remove_productIn is your request to remove a Product or Product/Version from your inventory
remove_productIn
vDNACPEManagement API Overview by Field
Element | Description | Data Type | Allowable Values | Required |
---|---|---|---|---|
login | This is your Security-Database User Login | xsd:string | See Description | Yes |
apikey | This is your API Key that you can found in your Security-Database User Panel (menu vDNA API) | xsd:string | 32 single-byte characters | Yes |
modulekey | This is your Module id that you can found in your Security-Database User Panel (menu vDNA API -> modules) | xsd:string | 32 single-byte characters | Yes |
cpeproduct | Your CPE product / Version. Must be CPE compatible Regexp : [cC][pP][eE]:/[AHOaho](:[A-Za-z0-9\._\-~%]*){0,6} | xsd:string | See Description | Yes |
cpetype | Specify if the Product is a Full Product (like Mozilla Firefox) '2' or a Product/Version '1' (like Mozilla Firefox 3.6) | xsd:int | 1|2 | Yes |
Example of remove_productIn
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:get="https://www.security-database.com/get_vdna_soapserver_cpemanagement.php"> <soapenv:Header/> <soapenv:Body> <get:remove_product soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <login xsi:type="xsd:string">testlogin</login> <apikey xsi:type="xsd:string">quJzDo7J5VDAouuNFuVvlDu6dAhlvfxS</apikey> <modulekey xsi:type="xsd:string">65de86d1ksn10odj1u42f4f66885d211</modulekey> <cpeproduct xsi:type="get:CPEproduct">cpe:/a:sun:jre</cpeproduct> <cpetype xsi:type="xsd:string">2</cpetype> </get:remove_product> </soapenv:Body> </soapenv:Envelope>
remove_productOut
vDNACPEManagement API Overview by Field
Element | Description | Data Type | Possible Values |
---|---|---|---|
return | return "OK" if successfull | xsd:string | See description |
Example of remove_productOut
Example of SOAP return. See the third block for the complex XML return with shema validation possibility. Schema available here : https://www.security-database.com/schemas/vdnacpemanagement.xsd
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https//www.security-database.comget_vdna_soapserver_cpemanagement.php" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:remove_productResponse> <return xsi:type="xsd:string">OK</return> </ns1:remove_productResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
get_inventory
get_inventoryIn is your request to list all Product or Product/Version from your inventory manage by your API
get_inventoryIn
vDNACPEManagement API Overview by Field
Element | Description | Data Type | Allowable Values | Required |
---|---|---|---|---|
login | This is your Security-Database User Login | xsd:string | See Description | Yes |
apikey | This is your API Key that you can found in your Security-Database User Panel (menu vDNA API) | xsd:string | 32 single-byte characters | Yes |
modulekey | This is your Module id that you can found in your Security-Database User Panel (menu vDNA API -> modules) | xsd:string | 32 single-byte characters | Yes |
Example of get_inventoryIn
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:get="https://www.security-database.com/get_vdna_soapserver_cpemanagement.php"> <soapenv:Header/> <soapenv:Body> <get:get_inventory soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <login xsi:type="xsd:string">testlogin</login> <apikey xsi:type="xsd:string">quJzDo7J5VDAouuNFuVvlDu6dAhlvfxS</apikey> <modulekey xsi:type="xsd:string">65de86d1ksn10odj1u42f4f66885d211</modulekey> </get:get_inventory> </soapenv:Body> </soapenv:Envelope>
get_inventoryOut
vDNACPEManagement API Overview by Field
Element | Description | Data Type | Possible Values |
---|---|---|---|
return | return a complex XML (validation with schema) | tns:wsGetInventoryResult | See description |
Example of get_inventoryOut
Example of SOAP return. See the third block for the complex XML return with shema validation possibility. Schema available here : https://www.security-database.com/schemas/vdnacpemanagement.xsd
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://www.ecurity-database.com/get_vdna_soapserver_cpemanagement.php" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:get_inventoryResponse> <return xsi:type="ns1:wsGetInventoryResult"> <cpeCount xsi:type="xsd:int">2</cpeCount> <detailsCpeList xsi:type="ns1:detailsCpeList"> <cpeDetail xsi:type="ns1:cpeDetail"> <name xsi:type="ns1:CPEproduct">cpe:/a:sun:jre</name> <added_date xsi:type="xsd:date">2012-12-28 17:22:17</added_date> <type xsi:type="xsd:int">2</type> <md5 xsi:type="xsd:string">589adf92764cb59426879f8c01008aee</md5> </cpeDetail> <cpeDetail xsi:type="ns1:cpeDetail"> <name xsi:type="ns1:CPEproduct">cpe:/a:mozilla:firefox:3.6.26</name> <added_date xsi:type="xsd:date">2012-09-19 12:13:33</added_date> <type xsi:type="xsd:int">1</type> <md5 xsi:type="xsd:string">56814982ea39e53722bd3eb66cae1a97</md5> </cpeDetail> </detailsCpeList> </return> </ns1:get_inventoryResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>