Utility API Endpoints
Decrypt Encrypted Strings
Endpoint:
POST api/v9/utility/clients/{clientIdentifier}/decrypt
Description:
Decrypts encrypted strings using a special Pointr algorithm.
Validations
- EncryptedString is required.
Request:
{
"encryptedString": "encrypted_data"
}
Success Response:
{
"decryptedString": "decrypted_data"
}
* You can access the possible response codes you may encounter here.
Upload Image
Endpoint:
POST api/v9/utility/clients/{clientIdentifier}/upload-image
Description:
Uploads a image for processing.
Validations
- FileType is required.
- ImageFile is required.
Request:
{
"fileType": "png",
"imageFile": "base64_encoded_image"
}
Success Response:
{
"message": "Image uploaded successfully.",
"imageUrl": "{cdnBaseUrl}/{clientIdentifier}/feature-images/image.png?sasToken"
}
* You can access the possible response codes you may encounter here.
Upload File
Endpoint:
POST api/v9/utility/clients/{clientIdentifier}/upload-file
Description:
Upload .geojson
, .json
, .dxf
, .dwg
, .pdf
, .png
, .jpeg
, .jpg
file.
Early validation will be performed after the file is uploaded.
Validations
- File is required.
Request:
file
: The file to be uploaded. This should be passed as a form-data parameter withContent-Type
set tomultipart/form-data
.
Success Response:
{
"message": "File is uploaded successfully.",
"fileUrl": "{cdnBaseUrl}/{clientIdentifier}/files/cad.dwg?sasToken"
}
* You can access the possible response codes you may encounter here.