AGV调式之软件开发—API调用

AGV调式之软件开发—API调用

1.登陆界面

2.构建一个REST API请求

①REST API请求是由特定的动词和名词组成的句子。
如果你能和你的机器人说话，你可能会说“给我你的电池电量”。REST API请求也是一个句子:您只需要知道元素的正确组合和顺序。
REST API请求的元素：

②详细解释REST API请求
(1)MEHTOD
描述你想MIR要做什么,主要使用4种HTTP方法:

(2)IP
你想要与机器人的IP地址进行通讯。

(3)API VERSION
所采用的是什么语言

(4)端点
您想访问的信息，在MiR的文档中查找端点。

MiR主要使用四种HTTP RESTful api: GET、PUT、POST和DELETE。

3.请求使用MIR的REST API文档

（1）定位文档
登录到机器人界面，然后转到Help > API documenttetlon。填写您的用户名和密码，然后选择Lounch API documenttetlon。

（2）定位文档使用
启动文档页面后，您可以浏览可用的方法。单击条目可以提供更多信息，例如成功或失败请求的示例输出。

（3）尝试命令
选择方法后，可以通过选择Try it out从文档页面执行它。然后选择水平蓝条上的Execute。响应如下所示。

4.REST API 授权头文件

授权包括验证客户端是否具有执行端点操作的权限。
在REST请求的头中，需要包含用户名和密码信息，但必须首先对其进行编码和加密。
（1）加密授权分为两步。
首先，用户名和密码需要用base64编码，格式如下:
用户名:
密码:
然后用SHA256对两者的编码组合进行加密。在机器人界面中导航Help > API文档。


(2)现在，我们已经掌握了如何构建请求和添加授权头，现在可以发送第一个请求了。

5.读取REST API响应

对带有STATUS端点的请求的响应返回关于机器人的大量信息。
(1)回复
下面的响应是JSON格式的。数据结构为名称/值对。这使得它可以自我描述，易于理解。
例如，下面我们可以看到机器人的名字(“robot_name”)是R2D2。

6.使用Postman测试REST API请求

使用Postman或类似的工具来测试API请求。
您可以使用各种工具来测试REST API请求并开发使用它们的代码：

（1）这节课将带您在名为Postman的开发工具中测试REST API请求。
在Postman中，您可以发出API请求并检查响应，而无需使用终端或编写任何代码。当您创建一个请求并单击Send时，API响应将出现在Postman用户界面中。
Postman网址:https://www.postman.com/
Postman是一个免费的开发工具，具有简单的UI，非常适合测试REST请求。Postman还可以将请求翻译成其他语言，如c#、Java和Python。

6.用Postman工作

如果您想在Postman中运行一个请求，则需要知道URL、方法和身份验证。
（1）创建请求
您的请求可以包括多个细节，以确定Postman将发送到MiR的API的数据。你需要做这些：
1.选择一个方法
2.输入一个网址
3.提供授权
可以使用 new>request 从Postman启动屏幕创建一个新请求,或者单击+按钮打开一个新选项卡。

(2)授权
您需要在Headers选项卡中添加正确的授权。键应为“Authorization”，值从机器人界面中获取。

（3）增加请求细节
Postman中的Body选项卡允许您指定要随请求发送的数据。当您想要添加或更新结构化数据时，您将需要与请求一起发送主体数据。例如，如果要发送一个更改机器人状态的请求，则应该以JSON格式包含所需的状态。通常，您将对PUT和POST请求使用主体数据。

（4）读取回复
您可以在Postman响应查看器中检查API请求的响应。API响应由主体、头部和状态代码组成。Postman在不同的标签中组织正文和标题。状态代码在选项卡旁边是可见的。

（5）状态码
每个REST请求将返回一个响应代码和内容。

7.让我们一起在Postman中发送一个REST API请求。您将使用PUT方法和状态端点清除机器人的错误状态。按下面打开邮差。

（1）The response
您以前见过以JSON格式返回的这个响应。要更改响应的语言，请使用正文部分中的下拉菜单

（2）Translating the request into code
①翻译的代码：
通过向右选择code，可以生成多种不同语言的代码片段。
②选择你的代码：
在下拉菜单中选择代码类型，可编程代码就会出现。然后可以用它来编写一个程序，调用机器人的状态。
（3）