设置您的API密钥

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

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

Diagram of the API Key configuration process. Method 1. Unsecure. Copy API key from Nixtla dashboard. 2. Paste API Key in Python code. 3. Validate API key. Method 2. Secure. One method, temporary. Open terminal. Set environment variable. Validate API key. Another method, permanent. Create .env File. Set API Key in file. Validate API Key.

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

这个方法很简单，适合快速测试或不会分享的脚本。

  • 步骤 1：从你的 Nixtla 控制台 中的 API Keys 复制API密钥。
  • 步骤 2：将密钥直接粘贴到你的Python代码中，通过用你的API密钥实例化 NixtlaClient：
from nixtla import NixtlaClient 
nixtla_client = NixtlaClient(api_key ='your API key here')
Important

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

2. 安全：使用环境变量

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

环境变量必须确切命名为 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文件，然后实例化NIXTLA_API_KEY类。例如：

from dotenv import load_dotenv
load_dotenv()

from nixtla import NixtlaClient
nixtla_client = NixtlaClient()

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

Important

请记住，您的API密钥就像密码 - 保持它的秘密，确保其安全！

3. 验证您的 API 密钥

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

nixtla_client.validate_api_key()

You don’t need to validate your API key every time you use TimeGPT. This function is provided for your convenience to ensure its validity. For full access to TimeGPT’s functionalities, in addition to a valid API key, you also need sufficient credits in your account. You can check your credits in the Usage section of your dashboard.

Give us a ⭐ on Github