有多个 API 端点可用于登录。此处描述的登录 API 是 /login。还有其他方法,例如 /auth/forceLogin,如果用户已登录,它会通过结束较旧的会话来强制登录。
要使用 Swagger API,请确保在 xserver.properties 中设置 xserver.swagger.enable=true
。
若要创建请求,请创建对 /login 的 POST 调用,例如 https://my-address/login。 调用的 JSON 正文应如下所示:
{ “username”:“myuser”, “password”:“qwer1234”, “domain”:“ubimax”,“ agreedToTos”:“true” }
在这里,我们指定用户名、密码和域。之后,我们可以执行请求。
我们得到的响应将如下所示:
{ “token”: “eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJGQ0MiLCJzdWIiOiJ0ZXN0ZXIiLCJkb21haW4iOiJ1YmltYXgiLCJpZCI6MTYyOTI4NDQ0ODg0OSwiaWF0IjoxNjI5Mjg0NDQ4LCJleHAiOjE2MjkyODQ3NDh9.h9.9qhH0Jpf-xtzPa5Gu3CUt89dVag-8obzV-dNYsGojs_GNdfSfcM_iJ4rA01-Wg7Gr3LQfRkjtLhC95AHLmtc5A”, “refreshToken”: “eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJGQ0MiLCJzdWIiOiJ0ZXN0ZXIiLCJkb21haW4iOiJ1YmltYXgiLCJpYXQiOjE2MjkyODQ0NDgsImV4cCI6MTYyOTg4OTI0OH0.-L38U0FsXHhOJCxWus4kXEezSm6tcZ3u2nKzhZX9C_0ZqyRrscG7sDNWsP8gUREeNRrXpvA1YAUqamQRQb8_QA“, ”权限“: [ ”ROLE_adm_administration“, ... ] }
对于以下 API 调用,我们现在可以使用我们收到的作为持有者令牌的令牌作为授权。
要大致了解可用的 API 调用,请访问 https://my-address/admin.html#!/apis。
在这里,所有 API 调用都列出了它们需要执行的数据,也可以试用。这将是 /login 的 API 描述:
在这里,我们看到 usernamePasswordLoginModel 是预期的,下面将其定义为示例。如果我们现在填写字段并执行请求,结果如下所示:
结果显示我们向其发送请求的 URL 和 curl 命令。