0a4641c24e
* feat(api-key): add IP whitelist/blacklist restriction and usage log IP tracking - Add IP restriction feature for API keys (whitelist/blacklist with CIDR support) - Add IP address logging to usage logs (admin-only visibility) - Remove billing_type column from usage logs UI (redundant) - Use generic "Access denied" error message for security Backend: - New ip package with IP/CIDR validation and matching utilities - Database migrations for ip_whitelist, ip_blacklist (api_keys) and ip_address (usage_logs) - Middleware IP restriction check after API key validation - Input validation for IP/CIDR patterns on create/update Frontend: - API key form with enable toggle for IP restriction - Shield icon indicator in table for keys with IP restriction - Removed billing_type filter and column from usage views * fix: update API contract tests for ip_whitelist/ip_blacklist fields Add ip_whitelist and ip_blacklist fields to expected JSON responses in API contract tests to match the new API key schema.
115 lines
2.7 KiB
TypeScript
115 lines
2.7 KiB
TypeScript
/**
|
|
* API Keys management endpoints
|
|
* Handles CRUD operations for user API keys
|
|
*/
|
|
|
|
import { apiClient } from './client'
|
|
import type { ApiKey, CreateApiKeyRequest, UpdateApiKeyRequest, PaginatedResponse } from '@/types'
|
|
|
|
/**
|
|
* List all API keys for current user
|
|
* @param page - Page number (default: 1)
|
|
* @param pageSize - Items per page (default: 10)
|
|
* @param options - Optional request options
|
|
* @returns Paginated list of API keys
|
|
*/
|
|
export async function list(
|
|
page: number = 1,
|
|
pageSize: number = 10,
|
|
options?: {
|
|
signal?: AbortSignal
|
|
}
|
|
): Promise<PaginatedResponse<ApiKey>> {
|
|
const { data } = await apiClient.get<PaginatedResponse<ApiKey>>('/keys', {
|
|
params: { page, page_size: pageSize },
|
|
signal: options?.signal
|
|
})
|
|
return data
|
|
}
|
|
|
|
/**
|
|
* Get API key by ID
|
|
* @param id - API key ID
|
|
* @returns API key details
|
|
*/
|
|
export async function getById(id: number): Promise<ApiKey> {
|
|
const { data } = await apiClient.get<ApiKey>(`/keys/${id}`)
|
|
return data
|
|
}
|
|
|
|
/**
|
|
* Create new API key
|
|
* @param name - Key name
|
|
* @param groupId - Optional group ID
|
|
* @param customKey - Optional custom key value
|
|
* @param ipWhitelist - Optional IP whitelist
|
|
* @param ipBlacklist - Optional IP blacklist
|
|
* @returns Created API key
|
|
*/
|
|
export async function create(
|
|
name: string,
|
|
groupId?: number | null,
|
|
customKey?: string,
|
|
ipWhitelist?: string[],
|
|
ipBlacklist?: string[]
|
|
): Promise<ApiKey> {
|
|
const payload: CreateApiKeyRequest = { name }
|
|
if (groupId !== undefined) {
|
|
payload.group_id = groupId
|
|
}
|
|
if (customKey) {
|
|
payload.custom_key = customKey
|
|
}
|
|
if (ipWhitelist && ipWhitelist.length > 0) {
|
|
payload.ip_whitelist = ipWhitelist
|
|
}
|
|
if (ipBlacklist && ipBlacklist.length > 0) {
|
|
payload.ip_blacklist = ipBlacklist
|
|
}
|
|
|
|
const { data } = await apiClient.post<ApiKey>('/keys', payload)
|
|
return data
|
|
}
|
|
|
|
/**
|
|
* Update API key
|
|
* @param id - API key ID
|
|
* @param updates - Fields to update
|
|
* @returns Updated API key
|
|
*/
|
|
export async function update(id: number, updates: UpdateApiKeyRequest): Promise<ApiKey> {
|
|
const { data } = await apiClient.put<ApiKey>(`/keys/${id}`, updates)
|
|
return data
|
|
}
|
|
|
|
/**
|
|
* Delete API key
|
|
* @param id - API key ID
|
|
* @returns Success confirmation
|
|
*/
|
|
export async function deleteKey(id: number): Promise<{ message: string }> {
|
|
const { data } = await apiClient.delete<{ message: string }>(`/keys/${id}`)
|
|
return data
|
|
}
|
|
|
|
/**
|
|
* Toggle API key status (active/inactive)
|
|
* @param id - API key ID
|
|
* @param status - New status
|
|
* @returns Updated API key
|
|
*/
|
|
export async function toggleStatus(id: number, status: 'active' | 'inactive'): Promise<ApiKey> {
|
|
return update(id, { status })
|
|
}
|
|
|
|
export const keysAPI = {
|
|
list,
|
|
getById,
|
|
create,
|
|
update,
|
|
delete: deleteKey,
|
|
toggleStatus
|
|
}
|
|
|
|
export default keysAPI
|