Cryptography API Reference
Overview
- This API provides endpoints for cryptographic operations and information retrieval.
- All requests and responses are expected to be in JSON format unless otherwise specified.
- Authentication may be required for certain endpoints. Refer to the authentication section.
- Rate limiting is enforced to ensure service stability.
Authentication
- API Keys: Include your API key in the
X-API-Key header.
- OAuth 2.0: Bearer tokens are supported. Include
Authorization: Bearer <your_token> in the header.
- Refer to our Authentication Guide for details.
Key Management
- Generate Key Pair: Create new asymmetric key pairs (e.g., RSA, ECC).
- Import Key: Import existing cryptographic keys.
- Export Key: Export cryptographic keys in various formats (e.g., PEM, DER).
- List Keys: Retrieve a list of managed keys.
- Revoke Key: Invalidate or revoke a key.
GET
/api/reference/security/cryptography/keys
POST
/api/reference/security/cryptography/keys
Encryption & Decryption
- Symmetric Encryption: Encrypt and decrypt data using symmetric algorithms (e.g., AES).
- Asymmetric Encryption: Encrypt data using public keys.
- Decryption: Decrypt data using private keys.
- Supports common modes like GCM, CBC.
POST
/api/reference/security/cryptography/encrypt
POST
/api/reference/security/cryptography/decrypt
Hashing & Signing
- Hash Data: Compute message digests using algorithms like SHA-256, SHA-3.
- Generate Signature: Create digital signatures for data integrity and authenticity.
- Verify Signature: Validate digital signatures.
POST
/api/reference/security/cryptography/hash
POST
/api/reference/security/cryptography/sign
POST
/api/reference/security/cryptography/verify
Secure Randomness
- Generate Random Bytes: Obtain cryptographically secure random bytes.
- Generate UUID: Generate universally unique identifiers.
GET
/api/reference/security/cryptography/random