Smart Proxy

The KBOSS Smart Proxy is the primary API endpoint that your application will need to encrypt and decrypt data.

URL

The Smart Proxy endpoint URL is:

https://<organization>.kbosscloud.com/proxy/<proxy-id>

This URL acts as a gateway for your application's requests, ensuring encryption and decryption are handled seamlessly.

Headers

KBOSS uses X-Headers to dynamically configure the smart proxy. These headers are crucial for specifying the behavior of the Smart Proxy with each request.

X-Headers Explanation

  • X-KBOSS-Authorization: Your unique authorization token for accessing the Smart Proxy.
  • X-KBOSS-Destination: The destination URL where the request needs to be sent after encryption/decryption.
  • X-KBOSS-Fields: Specifies which fields in the JSON payload should be encrypted or decrypted.
  • X-KBOSS-Classification: Classifies the data for additional handling rules (e.g., 'cui' for Controlled Unclassified Information).
  • X-KBOSS-Geofence: Defines the geofencing restrictions for data processing, indicated by a numeric ID.

Example Request Using cURL

Here is an example of how to make a request to the Smart Proxy using cURL:

curl --location 'https://.kbosscloud.com/proxy/' \
--header 'X-KBOSS-Authorization: cd_i89b5ZdVyhXuHrZnrSQCM0e2W3h5O7Fiwqd39dDdmf91a2ssLopP5wM' \
--header 'X-KBOSS-Destination: https://webhook.site/06f5b1c6-cb79-48a7-b274-5a2de32463c' \
--header 'X-KBOSS-Fields: title,body' \
--header 'X-KBOSS-Classification: cui' \
--header 'X-KBOSS-Geofence: 14' \
--header 'Content-Type: application/json' \
--data '{
    "userId": 1,
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "body": "quia et suscipit nsuscipit recusandae consequuntur expedita et"
}'

This example demonstrates how to send a request with specific headers for encryption or decryption of the JSON payload, along with other configuration details.

Usage Notes

  • Ensure that all the required X-Headers are included in your request.
  • The X-KBOSS-Fields header must match the fields present in your JSON payload.
  • Always verify your X-KBOSS-Authorization token for successful authentication.
  • Keep in mind the data classification and geofencing requirements for your application while using the Smart Proxy.