- 查询当前 API Key 的剩余额度和已使用额度
- 监控单个令牌的使用情况
- 支持 CORS 跨域请求
- 实时余额监控
获取当前 API Key(令牌)的剩余余额和已使用余额。此接口用于监控单个令牌的使用情况。
请求示例
bash
curl --request GET \
--url 'https://api.openveer.com/v1/balance' \
--header 'Authorization: Bearer <token>'
```python
import requests
API_BASE = 'https://api.openveer.com'
API_KEY = 'sk-xxxxxxxxxxxxxxxxxxxxxx'
headers = {
'Authorization': f'Bearer {API_KEY}'
}
def get_token_balance():
response = requests.get(f'{API_BASE}/v1/balance', headers=headers)
data = response.json()
if data.get('success'):
if data.get('unlimited_quota'):
print("令牌额度: 无限")
else:
print(f"令牌剩余余额: {data['remain_balance']}")
print(f"令牌已使用: {data['used_balance']}")
else:
print(f"查询失败: {data.get('message')}")
return data
get_token_balance()
```
```javascript
const API_BASE = 'https://api.openveer.com';
const API_KEY = 'sk-xxxxxxxxxxxxxxxxxxxxxx';
async function getTokenBalance() {
const response = await fetch(${API_BASE}/v1/balance, {
headers: {
'Authorization': Bearer ${API_KEY}
}
});
const data = await response.json();
if (data.success) {
if (data.unlimited_quota) {
console.log('令牌额度: 无限');
} else {
console.log(`令牌剩余余额: ${data.remain_balance}`);
}
console.log(`令牌已使用: ${data.used_balance}`);
} else {
console.error('查询失败:', data.message);
}
return data;
}
getTokenBalance();
```
```go
package main
import (
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
)
type BalanceResponse struct {
Success bool json:"success"
Message string json:"message,omitempty"
RemainBalance float64 json:"remain_balance"
UsedBalance float64 json:"used_balance"
UnlimitedQuota bool json:"unlimited_quota"
}
func main() {
url := "https://api.openveer.com/v1/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("Authorization", "Bearer <token>")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := ioutil.ReadAll(resp.Body)
var result BalanceResponse
json.Unmarshal(body, &result)
if result.Success {
if result.UnlimitedQuota {
fmt.Println("额度: 无限")
} else {
fmt.Printf("剩余余额: %.2f\n", result.RemainBalance)
}
fmt.Printf("已使用: %.2f\n", result.UsedBalance)
}
}
```
```java
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
public class Main {
public static void main(String[] args) throws Exception {
String url = "https://api.openveer.com/v1/balance";
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.header("Authorization", "Bearer <token>")
.GET()
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
```
```php
```
```ruby
require 'net/http'
require 'json'
require 'uri'
api_key = 'sk-xxxxxxxxxxxxxxxxxxxxxx'
url = URI("https://api.openveer.com/v1/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer #{api_key}"
response = http.request(request)
data = JSON.parse(response.body)
if data['success']
if data['unlimited_quota']
puts "额度: 无限"
else
puts "剩余余额: #{data['remain_balance']}"
end
puts "已使用: #{data['used_balance']}"
else
puts "查询失败: #{data['message']}"
end
```
```swift
import Foundation
let apiKey = "sk-xxxxxxxxxxxxxxxxxxxxxx"
let url = URL(string: "https://api.openveer.com/v1/balance")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.setValue("Bearer (apiKey)", forHTTPHeaderField: "Authorization")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let error = error {
print("Error: (error)")
return
}
if let data = data, let responseString = String(data: data, encoding: .utf8) {
print(responseString)
}
}
task.resume()
```
```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
static async Task Main(string[] args)
{
var apiKey = "sk-xxxxxxxxxxxxxxxxxxxxxx";
var url = "https://api.openveer.com/v1/balance";
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}");
var response = await client.GetAsync(url);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
}
}
```
响应示例
json
{
"success": true,
"remain_balance": 10.5,
"remain_credits": 105,
"used_balance": 2.3,
"used_credits": 23,
"unlimited_quota": false
}
json
{
"success": true,
"remain_balance": -1,
"remain_credits": -1,
"used_balance": 2.3,
"used_credits": 23,
"unlimited_quota": true
}
json
{
"success": false,
"message": "获取令牌信息失败: record not found"
}
json
{
"error": {
"code": 401,
"message": "身份验证失败,请检查您的API密钥",
"type": "authentication_error"
}
}
json
{
"error": {
"code": 429,
"message": "请求过于频繁,请稍后再试",
"type": "rate_limit_error"
}
}
认证
Authorization string接口端点
GET /v1/balance
GET /balance
两个端点功能相同,可以任选其一使用。
响应
success booleanmessage stringremain_balance floatremain_credits integerused_balance floatused_credits integerunlimited_quota boolean使用场景
- 监控单个 API Key 的消耗情况
- 在应用中显示当前令牌的余额
- 设置余额告警,当余额低于阈值时通知
常见错误
| 错误信息 | 原因 | 解决方案 |
|---|---|---|
| 无 Authorization 头 | 未提供 Authorization 请求头 | 添加 Authorization: Bearer sk-xxxxx 请求头 |
| 获取令牌信息失败 | 令牌不存在或已删除 | 检查令牌 key 是否正确 |