API reference / Devices, signing & primitives / TTEncrypt encode

TTEncrypt encode

Encrypt telemetry or registration JSON with TTEncrypt.

POSTapi.tikultra.com/v1/crypto/ttencrypt/encryptPrimitive · 2 credits

Upstream: local · TTEncrypt codec
Access: Every plan
Runs on: Primitive
Billing: Failed calls are free

Authorization

x-api-keyheader · stringrequired

Your API key. Create one in API keys.

Body

Send JSON with content-type: application/json.

plaintextstringrequired

UTF-8 JSON or string payload to encrypt. For example {"aid":1233,"app_name":"musical_ly","channel":"googleplay"}.

compressboolean

Gzip-compress before encrypting. For example true.

Response

A 200 returns JSON with stable field names. Every response carries x-credits-cost, x-credits-tier and x-credits-remaining.

Errors

Errors return a JSON body with a stable code and cost 0 credits. See Errors and retries.

curl -X POST https://api.tikultra.com/v1/crypto/ttencrypt/encrypt \ -H "x-api-key: $TIKULTRA_KEY" \ -H "content-type: application/json" \ -d '{"plaintext":"{\"aid\":1233,\"app_name\":\"musical_ly\",\"channel\":\"googleplay\"}","compress":true}'

{ "ciphertext_base64": "dGMFEAAAe8F4+5CYxfGXyqSNJKbB4euSFkEMBHrbAAAAAGr0+qqTnvZeQiJaT1YAP+hG7RjD5HJTyJqFqe4Xug/l5fu9ONiZw5iCWSHatRBC2IpRNzmUvHu/fPwsS7tpioWTaMXQONyxcOu9MqTWBAXACWXOxw/qsoRiWZJNWrcM/30DGr6Vgf2ntP/Y1BF3C0UzPyzwoaMuq0/NejyG5CK1XeiULw1d667pQ09gpklCjx32dbeZ877qjpcwG1r1xFwjXOCu", "ciphertext_hex": "7463051000007bc178fb9098c5f197caa48d24a6c1e1eb9216410c047adb000000006af4faaa939ef65e42225a4f5600" }