概观

Planet的任务处理API是一个编程接口,使客户能够以高效和自动化的方式来管理,并要求图像收集。随着任务处理API,客户可以:

  • 创建,编辑和取消天星点集合订单
  • 得到他们的订单的状态,并检查收集进度
  • 在尝试责成图像View元履行订单

自动任务处理是目前只适用于单天星点集合。随着我们不断提高我们的能力,我们计划支持额外的订单类型(区,音响,视频,批量订单等)。

关键概念

订购:请求以获得所关注的单个连续区域的图像。

订单状态:哪里的顺序是在其生命周期的表征 - 从创建和收集到订单履行。

捕获:这是在试图完成订单任务的图像。目前的订单和捕获之间的一对多的关系,作为订单可能需要以满足云盖规格或其他履行的标准来负责多次。一个给定的捕获可能会或可能不会完成任何顺序。

捕获状态:在哪里捕获是在其生命周期的表征 - 从上行到卫星在我们的目录中发布。

捕获评估:的捕获是否符合订单的规格,从而履行订单的表示。

订单状态

订单输入后,你可以检查任务API该订单的状态。下面概述了如何图表订单流过该系统。

  • 待定:订单已被接受,它的启动时间尚未过去。
  • 进行中:订单的开始时间已经过去了,它已准备好进行调度。在这种状态下时间将取决于当地的云层和收集能力。已采取捕获订单这不符合规格会留在进行中而他们正在重新定义。
  • 达到:订单满足履行规范的捕获。
  • 取消:订单已被取消。如果他们的订单可能会被取消待定要么进行中然而已经捕获排队处理要么发布时间在取消的时候,仍然可能会受到费用(详情请参阅捕获状态)。
  • 过期:订单的结束时间已经过去了,它的所有捕获的已发布时间,并没有符合规范。该命令将不再安排成像。
  • 失败:订单失败。

订单状态示例

要查看订单状态,您可以为您的订单ID GET请求。您还可以过滤通过追加订货元的订单。请参阅我们的API参考想要查询更多的信息。

端点

https://api.planet.com/tasking/v2/orders/?status=FULFILLED

例如响应

{ “ID”: “bfc45520-8a72-4d23-bfd1-7b22f23ed133”, “几何”:{ “类型”: “多边形”, “坐标”:[[[-77.306467,45.435827],[-77.229787,45.435827][-77.22975,45.489812],[-77.306504,45.489812],[-77.306467,45.435827]]]}, “capture_count”:2 “capture_status_queued_count”:0 “capture_status_processing_count”:0, “等级”:1,“START_TIME“: ”2019-09-30T20:30:50.836516Z“, ”END_TIME“: ”2020-09-27T23:59:59.999000Z“, ”CREATED_TIME“: ”2019-09-30T20:30:51.807703Z“,”名“: ”cairo_egypt“, ”状态“: ”应验“}

捕获状态

作为下关键概念所描述的,一个订单可以具有多个捕获,因为多个集合可能需要获得满足您的规格(云盖等)的图像。

订单的每个捕获有一个状态,这样你就可以一起在那里捕捉是在其生命周期通知收购或当图像可能被公布的预期随之而来。下面概述了图如何捕获流过该系统。

  • 排队:捕获已创建并发送至卫星。应当迫切获取和下行传输,典型地在约3个小时。
  • 处理:捕获已下行传输,并在我们的加工流水线。
  • 发布时间:捕获已发布到我们的目录,通常围绕后至10小时处理开始。
  • 失败:捕获未能被捕获或处理失败。

捕获状态示例

要查看您的订单的捕获的状态,你可以为捕获的GET请求,由订单ID(一个或多个)过滤。您还可以通过额外的元数据捕获过滤。请参阅我们的API参考想要查询更多的信息。

端点

https://api.planet.com/tasking/v2/captures/?order_id= <订单ID>

例如响应

{ “计数”:1, “下一步”:空, “以前”:空, “结果”:[{ “ID”: “1e0268d2-8c96-49ed-b809-eceafa563950”, “评价”: “成功”,“updated_time“: ”2019-09-21T23:57:43.783444Z“, ”acquired_time“: ”2019-09-21T08:51:31.094000Z“, ”published_time“: ”2019-09-21T23:57:43.783444Z“,“状态”: “出版的”, “status_description”:NULL, “strip_id”: “s104_20190921T085131Z”, “cloud_cover”:0.16, “ITEM_TYPE已”:[ “SkySatScene”, “SkySatCollect”]}]}

重新分配与评估

如果订单的采集不符合规格,它会直到其结束时间到期来重新定义。多次捕捉可收集的,以满足其云层和收集的要求。作为捕捉收集它们被算术评估云层也可能受到新一轮的人在半实物审查。

A捕获将被评定为成功如果云层小于或等于你的合同云层规格。如果捕获符合规格,其订单的状态将改变进行中完成

A捕获将被评定为无效如果云层超过合同规定。如果捕获是无效的,其订单的状态会留在请求的并如果它的结束时间还没有通过重新分派,或转换到已过期如果其结束时间已经过去了。

需要注意的是作为我们的人在半实物审查的一部分,由系统进行评估捕获可手动重新评估,这可能导致其订单的状态改变。例如,捕获系统标记为成功可以人工审核作为无效从改变其订单的状态完成进行中(要么已过期)。类似的命令,状态变化所预期的标记捕获无效这是人工审查作为成功。通常,任何人工审核发生在24小时内捕获的发布和变更订单的状态,由于人工评估此时间后不太可能。

范围

为了安全地大规模使用测试版的API任务处理的,每个组织使用任务处理API将有可配置的系统限制。请与您的客户经理联系,以确认您的组织的极限是什么。

最大活动订单指的是你可以在订单数量PENDING要么请求的状态。

为了最大持续时间不得超过你的合同期限或1年(以较早者为准结束)。

正在提交了订单创下的最高有效订单限制或超过最大订单持续时间将返回400错误的请求响应。

API访问

该任务处理API目前处于测试阶段。要确定是否有资格获得早期访问,请联系您的客户经理。

该任务处理API使用基本HTTP验证,并要求你有一个星球API密钥。要了解更多关于如何使用任务处理API认证,访问任务示例页面这并就如何创建订单实例等等。


评价这个指南: