Robocorp-Planhat：与Robocorp的Python自动化框架集成的Planhat API SDK

此自动化库旨在与Robocorp的Python自动化框架一起使用。它包括对基础Planhat API对象类型的建模，以及用于身份验证、检索和更新这些对象的定制客户端和相关会话。

有关Planhat API的更多信息，请参阅Planhat API文档。

安装

对于大多数用户，此项目应通过您的Robocorp自动化任务包或操作服务器包中的conda.yaml或package.yaml安装。例如

conda:
  channels:
    - conda-forge
  dependencies:
    - python=3.9.16
    - pip=22.1.2
    - pip:
      - robocorp==1.6.2
      - robocorp-planhat==1.0.0

或者，您可以使用您首选的安装方法直接从PyPI安装软件包。

入门

要使用Planhat API，您需要一个Planhat账户和一个API密钥。您可以在Planhat Web应用程序的设置 > 服务帐户下找到您的API密钥。您需要创建一个新的服务帐户并生成一个API密钥。

一旦您有了API密钥，您就可以使用Planhat API SDK对Planhat进行身份验证并检索数据。以下是如何使用Planhat API SDK检索公司列表的示例

from planhat import Planhat, types as ph_types

# Create a Planhat client
client = Planhat(api_key="your-api-key")

# Retrieve a list of Companies
companies = client.get_objects(ph_types.Company)

# Print the names of the companies
for company in companies:
    print(company.name)

使用控制室保险库

当与Robocorp Python自动化框架结合使用时，您可以使用Robocorp的Control Room Vault来存储您的Planhat API密钥。这是一种安全存储API密钥并从您的Robocorp自动化任务中访问它的方法。在Control Room Vault中创建密钥时，必须使用键api_key。以下是如何使用Planhat API SDK与Control Room Vault的示例

from robocorp.tasks import task
from planhat import Planhat, types as ph_types

@task
def get_companies():
    # Create a Planhat client
    client = Planhat(vault_secret_name="your-vault-secret-name")

    # Retrieve a list of Companies
    companies = client.get_objects(ph_types.Company)

    # Print the names of the companies
    for company in companies:
        print(company.name)

有关如何使用Robocorp Python自动化框架的更多文档，可以在Robocorp Docs网站找到。

API参考

有关特定类和方法的详细信息，请参阅API参考。

变更日志

查看CHANGELOG以了解重大变更的历史。