本教程将解释在使用 Nixtla SDK 时如何设置您的 API 密钥。要创建 API 密钥，请访问您的 仪表盘。

有多种方法可以设置您的 API 密钥。下面提供了一些示例。下方给出了示意图。

​
1. 直接将密钥复制并粘贴到您的 Python 代码中

这种方法简单直接，最适合快速测试或不共享的脚本。

  • 步骤 1: 从您的 Nixtla 仪表盘的“API 密钥”部分复制 API 密钥。
  • 步骤 2: 通过使用您的 API 密钥实例化 NixtlaClient，将密钥直接粘贴到您的 Python 代码中。
from nixtla import NixtlaClient 
nixtla_client = NixtlaClient(api_key ='your API key here')

重要事项

这种方法被认为不安全，因为您的 API 密钥将成为源代码的一部分。

​
2. 安全方法：使用环境变量

  • 步骤 1: 将您的 API 密钥存储在名为 NIXTLA_API_KEY 的环境变量中。这可以根据您的偏好 (a) 临时进行或 (b) 永久进行。
  • 步骤 2: 当您实例化 NixtlaClient 类时，SDK 将自动查找 NIXTLA_API_KEY 环境变量并使用它来验证您的请求。

重要事项

环境变量名称必须严格为 NIXTLA_API_KEY，全部为大写字母，拼写不能有任何偏差，SDK 才能识别它。

​
a. 临时：从终端

如果您在终端工作，并且需要一个临时解决方案，这种方法很有用。

​
Linux / Mac

打开终端并使用 export 命令设置 NIXTLA_API_KEY。

export NIXTLA_API_KEY=your_api_key

​
Windows

对于 Windows 用户，打开 Powershell 窗口并使用 Set 命令设置 NIXTLA_API_KEY。

Set NIXTLA_API_KEY=your_api_key

​
b. 永久：使用 .env 文件

为了获得更持久的解决方案，请将您的 API 密钥放置在您的 Python 脚本所在文件夹中的一个 .env 文件中。在此文件中，包含以下内容：

NIXTLA_API_KEY=your_api_key

现在您可以在 Python 脚本中加载环境变量了。使用 dotenv 包加载 .env 文件，然后实例化 NixtlaClient 类。例如：

from dotenv import load_dotenv
load_dotenv()

from nixtla import NixtlaClient
nixtla_client = NixtlaClient()

这种方法更安全，适合将要部署或共享的应用程序，因为它将 API 密钥排除在源代码之外。

重要事项

请记住，您的 API 密钥就像密码一样 - 保密，确保安全！

​
3. 验证您的 API 密钥

您始终可以在仪表盘的“API 密钥”部分找到您的 API 密钥。要检查您的 API 密钥状态，请使用 NixtlaClient 类的 validate_api_key 方法。如果 API 密钥有效，此方法将返回 True，否则返回 False。

nixtla_client.validate_api_key()

您无需每次使用 TimeGPT 时都验证您的 API 密钥。提供此功能是为了方便您确保其有效性。要完全访问 TimeGPT 的功能，除了有效的 API 密钥外，您还需要账户中有足够的信用点。您可以在 仪表盘的“使用情况”部分查看您的信用点。