Enterprise REST API概述

所有API调用都需要提交API令牌。根据您正在进行身份验证令牌的API调用类型,将更改。

例如,如果您自动执行扫描引擎的部署以在高度更改环境中的按需方案中扫描Web应用程序。您需要以下API标记。

  • 系统管理员- 所有扫描引擎操作都需要系统管理员令牌。
  • 客户帐户- 所有扫描配置和扫描的启动都需要使用客户帐户的令牌。

基本网址

  • http:// {servername} / appspiderenterprise / rest / v1 /
  • https:// {servername} / appspiderenterprise / rest / v1 /

验证

在使用AppSpider Enterprise API之前,您需要先将令牌添加到授权标题。

  1. 将POST请求发出登录端点http:// {servername} / apppiderenterprise / rest / v1 /验证/登录得到你的令牌。
  2. 使用响应令牌在请求标题作为基本授权令牌。
    1. 例如,授权:基本ABC0123

appspider身份验证

邮政

/ appspiderenterprise /休息/ v1 /验证/登录

描述返回appspider授权令牌。

要求身体

         
杰森
1
{
2
“姓名”“细绳”
3.
“密码”“细绳”
4.
}

示例请求

         
抨击
1
卷曲- request帖子\
2
- url http://%7bservername%7d / appspiderenterprise / rest / v1 /身份验证/登录\
3.
- 主人'内容类型:应用程序/ JSON'\
4.
- 数据'{“名称”:“字符串”,“密码”:“字符串”}'
         
红宝石
1
要求'uri'
2
要求'net / http'
3.
4.
URL.=Uri.“http:///%7bservername%7d / appspiderenterprise / rest / rest / v1 /验证/登录”
5.
6.
http.=http.新的URL.主持人URL.港口
7.
8.
要求=http.邮政新的URL.
9.
要求[“内容类型”]='application / json'
10.
要求身体=“{\”名称\“:\”字符串\“,\”password \“:\”字符串\“}”
11.
12.
回复=http.要求要求
13.
提出响应读取人员
         
Python
1
进口http.客户
2
3.
骗子=http.客户httpconnection.“insertconsole”
4.
5.
有效载荷=“{\ n \”name \“:\”InsertUsername \“,\ n \”password \“:\”InssidsPassword \“\ n}”
6.
7.
标题={
8.
'内容类型'“application / json”
9.
'缓存控制'“no-cache”
10.
}
11.
12.
骗子要求“邮政”“/ appspiderenterprise / rest / v1 /验证/登录”有效载荷标题
13.
14.
res.=骗子getResponse.
15.
数据=res.
16.
17.
打印数据解码“UTF-8”

回复

200 - 好的

         
杰森
1
{
2
“令牌”
3.
“发达群”真的
4.
“原因”空值
5.
“错误信息”空值
6.
}

400 - 糟糕的要求

         
杰森
1
{
2
“令牌”空值
3.
“发达群”错误的
4.
“原因”“无效证件”
5.
“错误信息”“无效的用户名或密码。”
6.
}
姓名 定义
发达群体 包含布尔值,如果执行正确的方法,则具有True。
原因 发生的错误文本。
错误信息 有关错误的其他信息。