Szyfruj tekst jawny za pomocą AES-256-GCM z automatycznie generowanym IV
Szyfruj tekst jawny za pomocą AES-256-GCM z automatycznie generowanym IV, tagiem uwierzytelniania i opcjonalnym wyprowadzaniem klucza scrypt
Żądanie
- x-api-key: <your-api-key>
- Content-Type: application/json
Odpowiedź
{
"algorithm": "<algorithm>",
"associatedDataProvided": true,
"ciphertext": "<ciphertext>",
"iv": "<iv>",
"keyDerivation": {
"kdf": "<kdf>",
"keyLengthBits": 22,
"salt": "<salt>"
},
"outputEncoding": "utf-8",
"status": "success",
"tag": "<tag>",
"tokensDeducted": 1
}Co robi
Szyfruj tekst jawny za pomocą AES-256-GCM z automatycznie generowanym IV, tagiem uwierzytelniania i opcjonalnym wyprowadzaniem klucza scrypt
Żądanie
Treść
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
associatedData | string | nie | Optional Additional Authenticated Data (AAD) bound to the GCM auth tag. |
key | string | nie | 32-byte key formatted in hex (64 chars), base64 (44 chars), or raw string. |
keyEncoding | enum | nie | One of: hex, base64, utf8. |
outputEncoding | enum | nie | One of: hex, base64, base64url. |
passphrase | string | nie | Optional passphrase used to derive a 256-bit key via scrypt if no raw key is supplied. |
plaintext | string | tak |
Przykładowe żądanie
{
"associatedData": "<associated data>",
"key": "example",
"keyEncoding": "hex",
"outputEncoding": "hex",
"passphrase": "<passphrase>",
"plaintext": "<plaintext>"
}Odpowiedź
| Pole | Typ | Opis |
|---|---|---|
algorithm | string | |
associatedDataProvided | boolean | |
ciphertext | string | |
iv | string | |
keyDerivation | object | |
↳ kdf | string | |
↳ keyLengthBits | integer | |
↳ salt | string | |
outputEncoding | string | |
status | string | |
tag | string | |
tokensDeducted | integer |
Przykładowa odpowiedź
{
"algorithm": "<algorithm>",
"associatedDataProvided": true,
"ciphertext": "<ciphertext>",
"iv": "<iv>",
"keyDerivation": {
"kdf": "<kdf>",
"keyLengthBits": 22,
"salt": "<salt>"
},
"outputEncoding": "utf-8",
"status": "success",
"tag": "<tag>",
"tokensDeducted": 1
}Błędy
Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.
400 | Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole. |
401 | Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key. |
402 | Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział. |
404 | Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują. |
429 | Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów. |
5xx | Usługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane. |
Kod
curl -X POST 'https://app.castomapi.com/v1/crypto/encrypt' \
-H 'x-api-key: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{"associatedData": "<associated data>", "key": "example", "keyEncoding": "hex", "outputEncoding": "hex", "passphrase": "<passphrase>", "plaintext": "<plaintext>"}'const res = await fetch('https://app.castomapi.com/v1/crypto/encrypt', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"associatedData": "<associated data>", "key": "example", "keyEncoding": "hex", "outputEncoding": "hex", "passphrase": "<passphrase>", "plaintext": "<plaintext>"})
});
const data = await res.json();
console.log(data);import { request } from 'node:https';
// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/crypto/encrypt', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"associatedData": "<associated data>", "key": "example", "keyEncoding": "hex", "outputEncoding": "hex", "passphrase": "<passphrase>", "plaintext": "<plaintext>"})
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
'https://app.castomapi.com/v1/crypto/encrypt',
headers={'x-api-key': '<your-api-key>'},
json={"associatedData": "<associated data>", "key": "example", "keyEncoding": "hex", "outputEncoding": "hex", "passphrase": "<passphrase>", "plaintext": "<plaintext>"},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/crypto/encrypt');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode(['associatedData' => '<associated data>', 'key' => 'example', 'keyEncoding' => 'hex', 'outputEncoding' => 'hex', 'passphrase' => '<passphrase>', 'plaintext' => '<plaintext>']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);Koszt i limity
Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.
Limity żądań na minutę
| Bez klucza | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
Pytania
Ile kosztuje Szyfruj tekst jawny za pomocą AES-256-GCM z automatycznie generowanym IV?
Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.
Jak się uwierzytelnić?
Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.
Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?
Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.
Jakie są limity?
10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.
OpenAPI: https://app.castomapi.com/docs/json