Tài liệu API · AuthBeta

Xác thực

Tạo khoá ở Tài khoản → Khoá API rồi gửi kèm như một bearer token. X-API-Key và ?api_key= cũng dùng được khi thử nhanh.

curl -s https://authbeta.com/api/v1/status \
  -H "Authorization: Bearer ab_xxxxxxxxxxxxxxxxxxxx"

Địa chỉ gốc: https://authbeta.com/api/v1 · Mọi phản hồi đều là JSON, có cờ ok.

Giới hạn tần suất

Mỗi khoá có mức dùng riêng tính theo phút (mặc định 120). Phản hồi kèm X-RateLimit-Limit, X-RateLimit-Remaining và X-RateLimit-Reset; vượt mức thì trả về 429 cùng tiêu đề Retry-After.

Lỗi

Mã	Ý nghĩa
400	Thiếu một trường bắt buộc.
401	Thiếu khoá, khoá sai, bị tắt hoặc đã hết hạn.
403	Khoá không có phạm vi mà điểm cuối này đòi hỏi.
404	Không có điểm cuối đó, hoặc không có mục kho đó.
422	Hiểu được dữ liệu gửi lên nhưng không dùng được.
429	Vượt quá giới hạn số lần gọi.
503	Quản trị viên đã tắt API.

{"ok": false, "error": "The \"secret\" field must be a valid base32 string."}

Danh sách endpoint

POST /totp scope: totp

Sinh mã từ một khoá bí mật, liên kết otpauth hoặc văn bản tự do.

Tham số	Kiểu	Bắt buộc	Mô tả
secret \| uri \| input	string	có	Khoá bí mật base32, một liên kết otpauth://, hoặc đoạn văn bản có chứa liên kết đó.
digits	int	không	4-10, mặc định 6
period	int	không	Số giây, mặc định 30
algorithm	string	không	SHA1 \| SHA256 \| SHA512 \| STEAM
counter	int	không	Có mặt = chạy kiểu HOTP
timestamp	int	không	Mốc thời gian Unix để tính mã tại đó
include_secret	bool	không	Trả lại cả khoá bí mật, mặc định false

POST /totp/verify scope: totp

Kiểm tra một mã có khớp với khoá bí mật không.

Tham số	Kiểu	Bắt buộc	Mô tả
secret	string	có	Khoá bí mật base32
code	string	có	Mã cần kiểm tra
window	int	không	Độ lệch cho phép tính theo bước, 0-10, mặc định 1

POST /totp/secret scope: totp

Tạo khoá bí mật ngẫu nhiên mới cùng liên kết otpauth của nó.

Tham số	Kiểu	Bắt buộc	Mô tả
bytes	int	không	10-64, mặc định 20 (160 bit)
label	string	không	Tên tài khoản
issuer	string	không	Tên dịch vụ

POST /totp/qr scope: totp

Vẽ mã QR ra PNG hoặc SVG.

Tham số	Kiểu	Bắt buộc	Mô tả
text \| secret	string	có	Văn bản bất kỳ, hoặc một khoá bí mật để dựng liên kết otpauth
format	string	không	png (mặc định) hoặc svg
scale	int	không	2-20, số điểm ảnh cho mỗi ô
ecc	string	không	L \| M \| Q \| H
raw	bool	không	Trả về chính tấm ảnh thay vì JSON

POST /totp/decode scope: totp

Đọc ảnh QR và trả về dữ liệu 2FA chứa trong đó.

Tham số	Kiểu	Bắt buộc	Mô tả
image	string	có	Dữ liệu ảnh base64, có hay không có tiền tố data: đều được

POST /totp/bulk scope: totp

Sinh mã cho cả một danh sách trong một lần gọi.

Tham số	Kiểu	Bắt buộc	Mô tả
text	string	có	Mỗi dòng một mục
delimiter	string	không	auto (mặc định), pipe, comma, tab, …
include_secret	bool	không	Trả lại cả khoá bí mật, mặc định false

POST /password scope: password

Sinh một hoặc nhiều mật khẩu.

Tham số	Kiểu	Bắt buộc	Mô tả
mode	string	không	random \| memorable \| pin \| hex \| base64 \| uuid
length	int	không	4-256
quantity	int	không	1-50
lowercase, uppercase, digits, symbols	bool	không	Bộ ký tự dùng cho chế độ random
exclude_ambiguous, no_repeat, no_sequential	bool	không	Ràng buộc thêm
words	int	không	2-12 cho chế độ memorable

POST /password/strength scope: password

Chấm điểm một mật khẩu.

Tham số	Kiểu	Bắt buộc	Mô tả
password	string	có	Mật khẩu cần phân tích

GET /ip/{ip} scope: ip

Thông tin một địa chỉ IP. Bỏ trống {ip} thì lấy chính địa chỉ của bạn.

GET /dns scope: ip

Bản ghi DNS của một tên miền.

Tham số	Kiểu	Bắt buộc	Mô tả
host	string	có	Tên miền
type	string	không	Danh sách ngăn bằng dấu phẩy, mặc định A,AAAA,MX,NS,TXT

GET /whois scope: ip

Dữ liệu WHOIS của một tên miền hoặc IP.

Tham số	Kiểu	Bắt buộc	Mô tả
query	string	có	Tên miền hoặc IP

POST /ports scope: ip

Kiểm tra cổng TCP hoặc UDP có nhận lưu lượng không. TCP trả về open/closed/filtered. UDP trả về open, closed (ICMP báo không tới được), likely_open (im lặng nhưng máy đích có báo cổng đóng) hoặc open|filtered, kèm trường icmp cho biết máy đích có báo cổng đóng không.

Tham số	Kiểu	Bắt buộc	Mô tả
host	string	có	Tên máy hoặc địa chỉ IP
protocol	string	không	tcp (mặc định) hoặc udp
ports	array\|string	không	Danh sách cổng, hoặc "53,123,161". Bỏ trống thì lấy các cổng thông dụng của giao thức đã chọn.

GET /email-security scope: ip

SPF, DMARC, MX, MTA-STS và TLS-RPT của một tên miền.

Tham số	Kiểu	Bắt buộc	Mô tả
domain	string	có	Tên miền

POST /text scope: text

Chạy một phép xử lý văn bản.

Tham số	Kiểu	Bắt buộc	Mô tả
text	string	có	Văn bản đầu vào
operation	string	có	Xem danh sách phép xử lý ở dưới
…	mixed	không	Tham số riêng của từng phép xử lý (delimiter, column, find, replace…)

GET /vault scope: vault

Liệt kê các tài khoản 2FA đã lưu kèm mã hiện tại.

GET /vault/{id}/code scope: vault

Mã hiện tại của một mục trong kho. Mục HOTP sẽ tăng bộ đếm.

GET /status

Thông tin về chính khoá bạn đang dùng.

Ví dụ

curl -s https://authbeta.com/api/v1/totp \
  -H "Authorization: Bearer ab_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"secret":"JBSWY3DPEHPK3PXP","digits":6}'

{
  "ok": true,
  "result": {
    "issuer": "", "label": "", "digits": 6, "period": 30,
    "algorithm": "SHA1", "type": "totp",
    "code": "123456", "next_code": "654321",
    "expires_in": 17, "server_time": 1771200000
  }
}

Phép xử lý văn bản

Các giá trị mà trường operation của POST /text nhận:

trim_lines remove_empty remove_duplicates sort_asc sort_desc sort_natural sort_length shuffle reverse_lines reverse_text number_lines unique_count extract_column replace_delimiter add_prefix_suffix wrap_lines find_replace regex_replace upper lower title sentence camel snake kebab toggle_case remove_spaces collapse_spaces remove_accents slugify base64_encode base64_decode url_encode url_decode html_encode html_decode hex_encode hex_decode json_escape json_pretty json_minify extract_emails extract_urls extract_ips extract_numbers extract_secrets hash_md5 hash_sha1 hash_sha256 hash_sha512 hash_crc32 join_lines split_length count_stats