TransIP API包装器

这些详情尚未由PyPI验证

项目链接

主页

项目描述

Python TransIP

python-transip 是一个用于 TransIP REST API V6 的 Python 包装器。

简介
通用
账户
- 发票
- SSH密钥
域名
VPS
HA-IP
托管
- 托管

简介

欢迎使用Python TransIP文档。

REST API V6

python-transip实现了新的TransIP REST API，以RESTful方式管理所有产品，这意味着对于大多数产品，您可以轻松地进行创建、更新和删除调用。

该包装器尽量接近官方API文档的命名约定。

SOAP V5 API（已弃用）

强烈建议用户使用新的REST API，因为SOAP API已被弃用。如果您仍然依赖于尚未在python-transip中实现的功能，请考虑提出一个功能请求，并在同时使用transip-api (已弃用)。

安装

python-transip可在PyPI上获得

$ python -m pip install python-transip

python-transip官方支持Python 3.6及以上版本。

文档

完整的API参考和用户指南可在Read the Docs上找到。

身份验证

为了通过python-transip管理TransIP产品，您需要经过身份验证。REST API V6需要使用符合JSON Web Token标准的访问令牌。

要获取访问令牌，您应首先使用控制面板生成密钥对。然后，您可以将私钥传递给python-transip客户端，允许客户端生成新的访问令牌，例如：

import transip

# You can initialize a TransIP client using a private key directly.
PRIVATE_KEY = '''-----BEGIN PRIVATE KEY-----
...
'''
client = transip.TransIP(login='demouser', private_key=PRIVATE_KEY)

# You can also initialize a TransIP client by telling it where to find the
# private key file on the system.
client = transip.TransIP(login='demouser', private_key_file='/path/to/private.key')

或者，您也可以通过提供访问令牌进行身份验证。这在使用演示令牌测试API时特别有用，例如：

import transip
from transip.v6 import DEMO_TOKEN

# You can initialize a TransIP client using an access token directly.
client = transip.TransIP(access_token=DEMO_TOKEN)

通用

通用TransIP API资源允许您管理产品、可用区域并调用API测试资源。

产品

管理可用的TransIP产品和产品规范。

Product 类

当列出TransIP上可用的所有产品时，将返回一个包含transip.v6.objects.Product对象的列表。

类 Product

Product类提供了以下属性

name：产品的名称。
description：产品描述。
price：以分计算的金额。
recurringPrice：产品的周期性价格，以分计算。
elements：列出产品元素的详细信息的服务。

ProductElement 类

当列出transip.v6.objects.Product对象的所有产品元素时，将返回一个包含transip.v6.objects.ProductElement对象的列表。

类 ProductElement

ProductElement类提供了以下属性

name：产品元素的名称。
description：产品元素描述。
amount：数量。

列出所有产品

检索具有其名称、描述和价格的产品的列表。

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# List all available TransIP products.
products = client.products.list()
# Show product information on the screen.
for product in products:
    print((
        f"Product {product.name} ({product.description}) costs "
        f"{product.price} (cents), after which it costs "
        f"{product.recurringPrice} (cents)"
    ))

列出产品的规格

获取产品的规范。这将列出产品的所有不同元素及其包含的数量，例如，vps-bladevps-x4有2个CPU核心元素。

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# Show product specification information on the screen for all available
# TransIP products.
for product in client.products.list():
    print(f"Product {product.name} ({product.description}):")
    elements = product.elements.list()
    for element in elements:
        print(f"- Has {element.amount} {element.name}: {element.description}")

可用区

管理TransIP可用区域。

AvailabilityZone 类

当列出TransIP上可用的所有可用区域时，将返回一个包含transip.v6.objects.AvailabilityZone对象的列表。

类 AvailabilityZone

AvailabilityZone类提供了以下属性

name：可用区域的名称。
country：可用区域所在国家的两位字母代码。
isDefault：如果为true，则此为默认区域，新VPS和克隆将创建在此区域。

列出可用区

检索可用的可用区域。

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# List all available availability zones.
zones = client.availability_zones.list()
# Show availability zone information on the screen.
for zone in zones:
    print((
        f"Availability zone {zone.name} in {zone.country} "
        f"(default: {zone.isDefault})"
    ))

API测试

一个简单的测试资源，以确保一切正常。

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# Check if everything is working by calling the API test resource.
if client.api_test.test():
    print("Everthing is working!")

账户

TransIP账户API资源允许您管理发票和SSH密钥。

发票

管理绑定到您的TransIP账户的发票。

Invoice 类

当列出绑定到您的TransIP账户的所有发票时，将返回一个包含transip.v6.objects.Invoice对象的列表。

类 Invoice

Invoice类提供了以下属性：

invoiceNumber：发票号码。
creationDate：发票创建日期。
payDate：发票支付日期。
dueDate：发票截止日期。
invoiceStatus：发票状态。
currency：此发票使用的货币。
totalAmount：发票总额（以分显示）。
totalAmountInclVat：包含增值税的发票总额（以分显示）。
items：列出单个发票项目的详细信息的服务。

InvoiceItem 类

当列出绑定到transip.v6.objects.Invoice对象的所有发票项目时，将返回一个包含transip.v6.objects.InvoiceItem对象的列表。

类 InvoiceItem

InvoiceItem类提供了以下属性：

product：产品名称。
description：产品描述。
isRecurring：支付是否为周期性。
date：订单行项目应开具发票的日期。
quantity：发票项目的数量。
price：不含增值税的价格（以分显示）。
priceInclVat：含增值税的价格（以分显示）。
vat：收取的增值税金额。
vatPercentage：计算增值税的百分比。
discounts：包含应用的折扣的字典。
- description：应用的折扣描述。
- amount：折扣金额（以分计）。

该类有以下方法

pdf(file_path)将发票存储为PDF文件，位置由file_path关键字参数提供。当file_path是目录时，PDF文件将使用发票号码作为其基本名称保存。

列出所有发票

通过调用transip.TransIP.invoices.list()检索绑定到您的TransIP账户的所有发票。这将返回一个包含transip.v6.objects.Invoice对象的列表。

例如

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# List all invoices attached to your TransIP account.
invoices = client.invoices.list()
# Show invoice information on the screen.
for invoice in invoices:
    print(f"Invoice {invoice.invoiceNumber} was paid on {invoice.payDate}")

注意：当使用演示访问令牌时，API当前不列出任何发票。

列出单个发票

通过调用transip.TransIP.invoices.get(id)根据其发票号码检索绑定到您的TransIP账户的单个发票。这将返回一个transip.v6.objects.Invoice对象。

例如

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# Retrieve a single invoice by its invoice number.
invoice = client.invoices.get('F0000.1911.0000.0004')
# Show invoice information on the screen.
print(f"Invoice {invoice.invoiceNumber} was paid on {invoice.payDate}")

注意：当使用演示访问令牌时，API当前不列出任何发票。

按发票编号列出发票项目

通过在transip.v6.objects.Invoice对象上调用items.list()来检索绑定到您的TransIP账户的单个发票的发票项目。这将返回一个包含transip.v6.objects.InvoiceItem对象的列表。

例如

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# Retrieve a single invoice by its invoice number.
invoice = client.invoices.get('F0000.1911.0000.0004')
# Retrieve all items of a single invoice.
items = invoice.items.list()
# Show invoice information on the screen.
for item in items:
    print(f"Product {item.product} ({item.description})")

注意：当使用演示访问令牌时，API当前不列出任何发票。

检索发票作为PDF文件

任何发票都可以通过在transip.v6.objects.Invoice对象上调用pdf(file_path)来保存为PDF文件。

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# Retrieve a single invoice by its invoice number.
invoice = client.invoices.get('F0000.1911.0000.0004')
# Save the invoice as a PDF file.
invoice.pdf('/path/to/invoices/')

注意：当使用演示访问令牌时，API当前不列出任何发票。

SSH密钥

SshKey 类

当列出绑定到您的TransIP账户的所有SSH密钥时，将返回一个包含transip.v6.objects.SshKey对象的列表。

类 SshKey

SshKey类提供了以下属性：

id：SSH密钥标识符。
key：SSH密钥。
description：SSH密钥描述（最大255个字符）。
creationDate：此SSH密钥被添加的日期（时区：欧洲/阿姆斯特丹）。
fingerprint：SSH密钥的MD5指纹。

该类有以下方法

delete()将删除您的TransIP账户中的SSH密钥。
update()将发送更新的属性到TransIP API。

列出所有SSH密钥

通过调用 transip.TransIP.ssh_keys.list() 获取您TransIP账户所有附加的SSH密钥。这将返回一个包含 transip.v6.objects.SshKey 对象的列表。

例如

import transip
# Initialize a client using the TransIP demo token.
client = transip.TransIP(access_token=transip.v6.DEMO_TOKEN)

# List all SSH keys attached to your TransIP account.
ssh_keys = client.ssh_keys.list()
# Show SSH key information on the screen.
for ssh_key in ssh_keys:
    print(f"SSH key {ssh_key.id} has fingerprint {ssh_key.fingerprint}")