Logo

Authentication

To authorize, use this Url:

POST: <Domain>/api/login/
Example: POST: https://api.kaptiche.com/api/login/

Response:

{
   " Status" : true,
   " StatusCode" : 200,
   " StatusMessage" :" Successfully logged in" ,
   " first_name" :" ramesh" , 
   " last_name" :" kkkk" ,
   " token" :" eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo3Niwid
            XNlcm5hbWUiOiJyYW1lc2gua2FubmFuQHNlbnNpcGxlLmNvbSIsImV4cCI6MT
            U5OTc1MDY5NywiZW1haWwiOiJyYW1lc2gua2FubmFuQHNlbnNpcGxlLmNvbSI
            sIm9yaWdfaWF0IjoxNTgxNzUwNjk3LCJhZG1pbiI6ZmFsc2UsInJvbGUiOi
            JVc2VyIn0.j5yG1ZVBzE1nltKtTMwQ_tdN3_89LQAzaBiugwaOHFE" ,
   " last_login" : true 
}
                

When the username and password is provided, user token is generated in the backend. User token is passed to the API for authentication as it is token based authentication. Passed token will be JWT (JSON Web Token). This JWT is passed for all the URLs that is to follow in the application when every action is performed.

Key Example
Username Unique username, e.g. Jack@mnhg.com
Password User password, e.g. mnbvc12@

Login

To login, use this Url:

POST: https://[url]/api/login/
Example: POST: https://api.kaptiche.com/api/login/

Response:

{
   " Status" : true,
   " StatusCode" : 200,
   " StatusMessage" :" Successfully logged in" ,
   " first_name" :" Kaptiche" ,
   " last_name" :" Admin" ,
   " token" :"token" ,
   " profile_id" : 1,
   " group_id" : 4,
   " group_name" :" Super Admin" 
}
                

When registered username and password is provided in the login page, login token is passed in the backend. Login token contains the security credentials for a login session and identifies the user.

Key Example
Username Unique username, e.g. Jack@mnhg.com
Password User password, e.g. mnbvc12@

Logout

To logout, use this Url:

POST: https://[url]/api/logout/
Example: POST: https://api.kaptiche.com/api/logout/

Response:

{
    "status" : true,
    "statuscode":200,
    "Statusmessage" :"Sucessfully logged out"
}
                

When user is about to logout from the application using Logout button, Logout token is passed in the backend and user is redirected to application login page.

Change Password

To change password, use this Url:

PUT: https://[url]/api/change-password/
Example: PUT: https://api.kaptiche.com/api/change-password/

Response:

{ 
   " Status" :" password has changed successfully" 
}
{
   " Status" : true, 
   " StatusCode" : 200,
   " StatusMessage" :" Successfully logged in" ,
   " first_name" :" Kaptiche" ,
   " last_name" :" Admin" ,
   " token" :" token" ,
   " profile_id" : 1,
   " group_id" : 4,
   " group_name" :" Super Admin" 
}
                    

When user enters the old and new password for performing change password operation, JSON Web Token is passed in the backend.

Key Example
Old password User password, e.g. mnbvv@31&
New password Password to be updated, e.g. werty%%6

Forget Password/Password-Reset

To reset password, use this Url:

PUT: https://[url]/api/password_reset/ 
Example: PUT: https://api.kaptiche.com/api/password_reset/

Response:

{
   " Status" :" OK" 
}
                        

When the registered mail Id is entered by the user for performing forgot password operation, a request body is sent and a process completion response is received.

Key Example
E-mail User mail Id, e.g. jack@sensiple.com

Group

Group List

For group list, use this Url:

GET: https://[url]/api/group/
Example: GET: https://api.kaptiche.com/api/group/

Response:

[ 
    {  
       " id" : 4,
       " group_name" :" Super Admin" ,
       " group_description" :" This role have all access in Super 
                                Admin level",
       " workflow_no" : 0,
       " manual_import" : true,
       " web_scanner_import" : false,
       " email_import" : false,
       " unc_import" : false,
       " export" : true,
       " inventory" : true,
       " view_manuals" : true,
       " validate_manuals" : false,
       " workflow_level" : false 
    },
    { 
       " id" : 1,
       " group_name" :" Security" ,
       " group_description" :" This role have all access in Security
                                 level" ,
       " workflow_no" : 1,
       " manual_import" : true,
       " web_scanner_import" : false,
       " email_import" : false,
       " unc_import" : false,
       " export" : false,
       " inventory" : false,
       " view_manuals" : false,
       " validate_manuals" : false,
       " workflow_level" : true 
    }, 
    {
       " id" : 2,
       " group_name" :" Store User" ,
       " group_description" :" This role have all access in Store level",
       " workflow_no" : 2,
       " manual_import" : true,
       " web_scanner_import" : true,
       " email_import" : true,
       " unc_import" : true,
       " export" : false,
       " inventory" : false,
       " view_manuals" : true,
       " validate_manuals" : true,
       " workflow_level" : true
    },
    {
       " id" : 3,
       " group_name" :" Financial Editor" ,
       " group_description" :" This role have all access in Financial
                                 level" ,
       " workflow_no" : 3,
       " manual_import" : true,
       " web_scanner_import" : true,
       " email_import" : true,
       " unc_import" : true,
       " export" : true,
       " inventory" : true,
       " view_manuals" : true,
       " validate_manuals" : true,
       " workflow_level" : true 
    }
] 
                            

When user requires group list, a request body is sent and group list is retrieved and displayed.

Group Get

To get group, use this Url:

GET: https://[url]/api/group/[ID]/
Example: GET: https://api.kaptiche.com/api/group/6/

Response:

{
   " id" : 1,
   " group_name" :" Security" ,
   " group_description" :" This role have all access in Security level" ,
   " workflow_no" : 1,
   " manual_import" : true,
   " web_scanner_import" : false,
   " email_import" : false,
   " unc_import" : false,
   " export" : false,
   " inventory" : false,
   " view_manuals" : false,
   " validate_manuals" : false,
   " workflow_level" : true
}
                            

When the registered mail Id is entered by the user for performing forgot password operation, a request body is sent and a process completion response is received.

Group Create

To create group, use this Url:

POST: https://[url]/api/group/
Example: POST: https://api.kaptiche.com/api/group/

Response:

{
    'status': 'New group has been created successfully'
}
                            

When required details are provided by the user to create a new group, a request body is sent and a response of new group creation is performed.

Key Example
group name Miro
group description miro
workflow_no 3
manual_import true
web_scanner_import false
email_import true
unc_import false
export false
inventory true
view_manuals false
validate_manuals true
workflow_level true

Group Update

To update group, use this Url:

PUT: https://[url]/api/group/[ID]/
Example: PUT: https://api.kaptiche.com/api/group/6/

Response:

{
   " group_name" :" Miro" ,
   " group_description" :" miro" ,
   " workflow_no" : 4,
   " manual_import" : false,
   " web_scanner_import" : true,
   " email_import" : false,
   " unc_import" : false,
   " export" : true,
   " inventory" : true,
   " view_manuals" : true,
   " validate_manuals" : true,
   " workflow_level" : true
}
                            

When user updates the fields, a request body is sent and a response is received with updated fields.

Key Example
group name Miro
group description miro
workflow_no 3
manual_import true
web_scanner_import false
email_import true
unc_import false
export false
inventory true
view_manuals false
validate_manuals true
workflow_level true

Group Delete

To delete group, use this Url:

DELETE: https://[url]/api/group/[ID]/
Example: DELETE: https://api.kaptiche.com/api/group/6/

Response:

{
   " message" :"Level Deleted Successfully" 
}
                            

When user deletes the level, a request body is sent and the response is received with deletion of level.

User

User List

For user list, use this Url:

POST: https://[url]/api/user-list/
Example: POST: https://api.kaptiche.com/api/user-list/

Response:

[
    {
       " id" : 1,
       " email" :" kapticheadmin@sensiple.com" ,
       " first_name" :" Kaptiche" ,
       " last_name" :" Admin" ,
       " active" : true,
       " group" :" Super Admin" 
    }
] 
                            

When Admin requires user list, a request body is sent and user list is retrieved and displayed.

User Create

To create user, use this Url:

POST: https://[url]/api/user-create/
Example: POST: https://api.kaptiche.com/api/user-create/

Response:

{
   " Status" :true,
   " StatusMessage" :"User created successfully" ,
   " StatusCode" :200
} 
                            

When required details are provided by the admin to create new user, a request body is sent and a response of new user creation is performed.

Key Example
email Mnvagh@ghj.com
first_name Jack
last_name San
group Financial editor

User Update

To update user, use this Url:

PUT: https://[url]/api/user-update/[ID]/
Example: PUT: https://api.kaptiche.com/api/user-update/2/

Response:

{
   " Status" :true,
   " StatusMessage" :"User updated successfully" ,
   " StatusCode" :200
}
                            

When admin updates the user fields, a request body is sent and a response is received with updated user fields.

Key Example
first_name Jane
last_name Saga
group Store user

User Activate/Deactivate

To activate/deactivate user, use this Url:

DELETE: https://[url]/api/user-delete/[ID]/
Example: DELETE: https://api.kaptiche.com/api/user-delete/2/

When admin activates and deactivates the user, a request body is sent and a response is received.

Configuration

UNC List

For unc list, use this Url:

GET: https://[url]/api/UNCconfig/
Example: GET: https://api.kaptiche.com/api/UNCconfig/

Response:

{
   " Configuration" : {
       " id" : 1,
       " unc_path" :" /home/jyggh/Pictures/Amb/workflow_backend
                    /media/unc_scanner" 
    }            
}
                            

When unc configuration list is requested, a request body is sent and unc configuration list is retrieved and displayed.

UNC Create

To create unc, use this Url:

POST: https://[url]/api/UNCconfig/
Example: POST: https://api.kaptiche.com/api/UNCconfig/

Response:

{
   " Configuration" :"saved successfully" 
}
                            

When required details are provided, request body is sent and a response of new unc path configuration is done.

Key Example
unc_path Home/dev/ambt/unc_scanner

UNC Update

To update unc, use this Url:

PUT: https://[url]/api/UNCconfig/[ID]/
Example: PUT: https://api.kaptiche.com/api/UNCconfig/3/

Response:

{
    'Status': True,
    'StatusMessage': 'UNCConfig updated successfully',
    'StatusCode': 200
}
                            

When updated unc path is provided, a request body is sent and a response is received with updated unc path.

Key Example
unc_path Home/Jack/rad/unc_scanner

Email List

To update unc, use this Url:

GET: https://[url]/api/emailconfig/
Example: GET: https://api.kaptiche.com/api/emailconfig/

Response:

{
   " Configuration" : { 
       " id" : 1,
       " email" :" jayashree.g@sensiple.com" ,
       " password" :" Admin@0291" ,
       " server" :" outlook.office.com" ,
       " port" : 993 
    }
}
                            

When Email list is requested, a request body is sent and Email list is retrieved and displayed.

Email Create

To create email, use this Url:

POST: https://[url]/api/emailconfig/
Example: POST: https://api.kaptiche.com/api/emailconfig/

Response:

{
   " Configuration" :"saved successfully" 
}
                            

When required details are provided, request body is sent and a response of new email configuration is done.

Key Example
email qwetrt@ert.com
password Asdfgg@32$
server outlook.office.com
port 985

Email Update

To update email, use this Url:

PUT: https://[url]/api/emailconfig/ID/
Example: PUT: https://api.kaptiche.com/api/emailconfig/3/

Response:

{
    'Status': True,
    'StatusMessage': 'UNCConfig updated successfully',
    'StatusCode': 200
}
                            

When updated email details are provided, a request body is sent and a response is received with updated unc path.

Key Example
email rtyuu@ert.com
password Ashh@32$qq
server outlook.office.com
port 785

Web Scanner List

To get web scanner list, use this Url:

GET: http://[url]/api/Webconfig/
Example: GET: https://api.kaptiche.com/api/Webconfig/

Response:

{
    "Configuration": {
        "id": 1,
        "web_path": "/home/jayashri/Pictures/Ambattur_SVN
                    /workflow_api_backend/media/web_scanner"
    } 
}
                            

When Web scanner list is requested, a request body is sent and web scanner list is retrieved and displayed

Web Scanner Create

To create web scanner list, use this Url:

POST: https://[url]/api/Webconfig/
Example: POST: https://api.kaptiche.com/api/Webconfig/

Response:

{
    "Configuration":"saved successfully"
} 
                        

When required details are provided, request body is sent and a response of new web scanner configuration is done.

Key Example
web_path home/dev/scanner/

Web Scanner Update

To update web scanner Update, use this Url:

PUT: https://[url]/api/Webconfig/[ID]/
Example: PUT: https://api.kaptiche.com/api/Webconfig/2/

Response:

{
    'Status': True,
    'StatusMessage': 'WebConfig updated successfully',
    'StatusCode': 200
}  
                        

When updated web path is provided, a request body is sent and a response is received with updated web scanner path.

Key Example
web_path home/dev/new_scanner/

Preprocessing List

To get preprocessing list, use this Url:

GET: https://[url]/api/auto_preprocessing/
Example: GET: https://api.kaptiche.com/api/auto_preprocessing/

Response:

{
    "Configuration": {
        "id": 1,
        "crop": true,
        "grayscale": true,
        "threshold": true,
        "sharpen": true,
        "shadowRemover": false,
        "bgSmooth": false,
        "watermark": true
    }
}  
                        

When Preprocessing list is requested, a request body is sent and Preprocessing list is retrieved and displayed.

Preprocessing Create

To create preprocessing, use this Url:

POST: https://[url]/api/auto_preprocessing/
Example: POST: https://api.kaptiche.com/api/auto_preprocessing/

Response:

{
    'Status': True,
    'StatusMessage': 'Auto_preprocess updated successfully',
    'StatusCode': 200
} 
                        

When required details are provided, request body is sent and a response of new preprocessing configuration is done.

Key Example
Crop false
Grayscale true
Threshold true
Sharpen true
Shadow Remover false
bgSmooth false
watermark true

Preprocessing Update

To update preprocessing, use this Url:

PUT: https://[url]/api/auto_preprocessing/[ID]/
Example: PUT: https://api.kaptiche.com/api/auto_preprocessing/3/

Response:

{
    'Status': True,
    'StatusMessage': 'Auto_preprocess updated successfully',
    'StatusCode': 200
} 
                        

When updated fields are provided, a request body is sent and a response is received with updated preprocessing features.

Key Example
Crop false
Grayscale true
Threshold true
Sharpen true
Shadow Remover false
bgSmooth false
watermark true

Table Configuration Get

To get configuration, use this Url:

GET: https://[url]/api/tableconfig/
Example: GET: https://api.kaptiche.com/api/tableconfig/

Response:

{
    "Configuration": {
        "margin_validation": true,
        "total_calculation": false
    }
}  
                        

When configuration is required, a request body is sent and configuration information is retrieved and displayed.

Table Configuration Create

To create configuration, use this Url:

POST: https://[url]/api/tableconfig/
Example: POST: https://api.kaptiche.com/api/tableconfig/

Response:

{
    "Configuration":"saved successfully"
}
                        

When required details are provided, request body is sent and new configuration is performed as response.

Key Example
Margin validation false
Total Calculation true

Configuration Update

To update configuration, use this Url:

PUT: https://[url]/api/tableconfig/[ID]/
Example: PUT: https://api.kaptiche.com/api/tableconfig/2/

Response:

{
    "table Configuration": "saved successfully"
} 
                        

When updated fields are provided, a request body is sent and a response is received with updated configuration.

Key Example
Margin validation false
Total Calculation true

Dashboard

For dashboard, use this Url:

POST: https://[url]/api/dashboard/
Example: POST: https://api.kaptiche.com/api/dashboard/

Response:

{
    "Manual": [
        {
            "Manual_name": "Manual",
            "Manual_total": 1,
            "Manual_Fin": 1,
            "Manual_Par": 0,
            "Manual_Fail": 0
        } 
    ],
    "Email": [
        {
            "Email_name": "Email",
            "Email_total": 0,
            "Email_Fin": 0,
            "Email_Par": 0,
            "Email_Fail": 0
        }
    ],
    "UNC": [
        {
            "UNC_name": "UNC Scanner",
            "UNC_total": 0,
            "UNC_Fin": 0,
            "UNC_Par": 0,
            "UNC_Fail": 0
        }
    ],
    "Web": [
        {
            "Web_name": "Web Scanner",
            "Web_total": 0,
            "Web_Fin": 0,
            "Web_Par": 0,
            "Web_Fail": 0
        }
    ],
    "Vendor": [
        {
            "Total_Vendor": 0
        }
    ],
    "Purchaseorder": [
        {
            "Total_Purchaseorder": 0
        }
    ],
    "Status": true,
    "StatusCode": 200
}
                

When key performance indicator is to be displayed, a request is sent and a dashboard response is received.

Key Example
Username Unique username, e.g. Jack@mnhg.com
Password User password, e.g. mnbvc12@

Vendor

Vendor List

For vendor list, use this Url:

GET: https://[url]/api/vendor_list/
Example: GET: https://api.kaptiche.com/api/vendor_list/

Response:

{
    "Vendor_details": [
        {
            "id": 1,
            "Name": "Mike",
            "Description": "sdasd",
            "Email": "mxxxhrxxe.g@ssdsd.com"
        }
    ]
} 
                            

When vendor list is requested, a request body is sent and vendor list is retrieved and displayed

Vendor Get

To get vendor, use this Url:

GET: https://[url]/api/vendor_get/[ID]/
Example: GET: https://api.kaptiche.com/api/vendor_get/3/

Response:

{
    "id": 1,
    "Title": "Mr.",
    "Name": "Mike",
    "company_code": "254545",
    "account_no": "123423658941234",
    "bank_name": "state bank of india",
    "beneficiary_name": "jayashree",
    "branch": "sadff",
    "IFSC_code": "hdfc1234512",
    "Description": "sdasd",
    "house_number": "no123",
    "street": "ABC",
    "city": "Chennai",
    "state": "Tamil Nadu",
    "country": "India",
    "Postal_code": "653298",
    "PO_BOX": "65329",
    "Phone_number": "9865606490",
    "Phone_Extension": "",
    "Fax": "1332565",
    "Fax_Extension": "044",
    "Email": "jayashree.g@sensiple.com"
}
                            

When vendor list is requested, a request body is sent and vendor list is retrieved and displayed

Vendor Create

To create vendor, use this Url:

POST: https://[url]/api/vendor_details/
Example: POST: https://api.kaptiche.com/api/vendor_details/

Response:

{
    "Statusmessage":"saved successfully"
} 
                            

When required details are provided, request body is sent and new vendor is created as response

Key Example
Title Mr/Ms/Mrs
Name Jone
Company code 654123
Account_no 123423658941234
Bank_name Indian Overseas Bank
Beneficiary_name Jack Jone
Branch Annasalai
IFSC code hdfc1234512
Description Tahanakayaoau
House_number no123
Street Vivekanand street
City Sharjah
State Abu Dhabi
Country Dubai
Postal_code 653298
PO_BOX 65329
Phone_number 7894561230
Phone_Extension 0422
Fax 1332565
Fax_Extension 042
Email jonedane@fgg.com

Vendor Update

To update vendor, use this Url:

PUT: https://[url]/api/vendor_details/[ID]/
Example: PUT: https://api.kaptiche.com/api/vendor_details/2/

Response:

{
    'Status': True,
    'StatusMessage': 'Vendor details updated successfully',
    'StatusCode': 200
} 
                            

When updated fields are provided, a request body is sent and a response is received with updated fields

Key Example
Title Mr/Ms/Mrs
Name Jone
Company code 654123
Account_no 123423658941234
Bank_name Indian Overseas Bank
Beneficiary_name Jack Jone
Branch Annasalai
IFSC code hdfc1234512
Description Tahanakayaoau
House_number no123
Street Vivekanand street
City Sharjah
State Abu Dhabi
Country Dubai
Postal_code 653298
PO_BOX 65329
Phone_number 7894561230
Phone_Extension 0422
Fax 1332565
Fax_Extension 042
Email jonedane@fgg.com

Vendor Delete

To delete vendor, use this Url:

DELETE: https://[url]/api/vendor_details/[ID]/
Example: DELETE: https://api.kaptiche.com/api/vendor_details/2/

Response:

{
    'Status': True,
    'StatusMessage': 'Vendor deleted successfully',
    'StatusCode': 200
} 
                            

When vendor deletion is requested, a request body is sent and selected vendor information is deleted

Item

Item List

For item list, use this Url:

GET: https://[url]/api/item_list/
Example: GET: https://api.kaptiche.com/api/item_list/

Response:

[
    {
        "id": 1,
        "vendor": "Mike",
        "item_name": "Keyboard",
        "item_description": "dfdsdsgdsg",
        "unit_price": "300",
        "tax": "0",
        "unit_type": "kilogram",
        "item_code": "CD12",
        "threshold": "22"
    }
] 
                            

When item list is requested, a request body is sent and item list is retrieved and displayed

Item Create

For create item, use this Url:

POST: https://[url]/api/itemcreate_manual/
Example: POST: https://api.kaptiche.com/api/itemcreate_manual/

Response:

{
    'Status': True,
    'StatusMessage': 'Item created successfully',
    'StatusCode': 200
} 
                            

When required details are provided, request body is sent and new item is created as response

Item Update

For create item, use this Url:

PUT: https://[url]/api/itemcreate_manual/
Example: PUT: https://api.kaptiche.com/api/itemcreate_manual/

Response:

{
    'Status': True,
    'StatusMessage': 'Item updated successfully',
    'StatusCode': 200
} 
                            

When updated fields are provided, a request body is sent and a response is received with updated fields

Key Example
Vendor Jone
item_name Pen
Item_description Red and white
Unit_price 25
Tex 12.5
Unit_type kilogram
Item_code MN31
Threshold 23

Item Delete

For delete item, use this Url:

DELETE: https://[url]/api/item_update/item_delete/[ID]/
Example: DELETE: https://api.kaptiche.com/api/item_delete/2/

Response:

{
    'Status': True,
    'StatusMessage': 'Item deleted successfully',
    'StatusCode': 200
}
                            

When item deletion is requested, a request body is sent and selected item information is deleted

Unit Type

For unit type, use this Url:

GET: https://[url]/api/unit_type_add/
Example: GET: https://api.kaptiche.com/api/unit_type_add/

Response:

[
    {
        "id": 1,
        "unit_type": "kilogram"
    },
    {
        "id": 2,
        "unit_type": "litres"
    },
    {
        "id": 3,
        "unit_type": "centimeter"
    }
] 
                            

When unit type is requested, a request body is sent and unit type of the item(s) is retrieved and displayed

Unit Create

For unit type, use this Url:

POST: https://[url]/api/unit_type_add/
Example: POST: https://api.kaptiche.com/api/unit_type_add/

Response:

{
    'Status': True,
    'StatusMessage': 'Unit Type created successfully',
    'StatusCode': 200
}  
                            

When required details are provided, request body is sent and new unit is created as response

Key Example
URL http://[url]/api/unit_type_add/

Purchase Order

Purchase Order Creation

For purchase order creation, use this Url:

POST: https://[url]/api/pocreation/
Example: POST: https://api.kaptiche.com/api/pocreation/

Response:

{
    "ponumber": 709088,
    "Status": true,
    "StatusMessage": "Purchaseorder created successfully",
    "StatusCode": 200
} 
                            

When required details are provided, request body is sent and new PO is created as response

Purchase Order List

For purchase order list, use this Url:

GET: https://[url]/api/pocreation/
Example: GET: https://api.kaptiche.com/api/pocreation/

Response:

{
    "Purchaseorder_details": [
        {
            "id": 1,
            "Name": "Mike",
            "ponumber": "709088",
            "filename": "invoice_709088.pdf",
            "filepath": "/media/generated_po/invoice_709088.pdf"
        }
    ]
} 
                            

When purchase order list is requested, a request body is sent and purchase order list is retrieved and displayed.

Purchase Order Generation

For purchase order generation, use this Url:

POST: https://[url]/api/generated_pdf/
Example: POST: https://api.kaptiche.com/api/generated_pdf/

Response:

{
    "Status": "True",
    "StatusMessage": "Generated pdf moved to destination folder",
    "StatusCode": 200
} 
                            

When generated pdf is required, a request body is sent and generated pdf is moved to the destination folder.

Huge Vendor Information Upload

For huge vendor information upload, use this Url:

POST: https://[url]/api/vendor_upload/
Example: POST: https://api.kaptiche.com/api/vendor_upload/

Response:

{
    "Status": True,
    "Statusmessage":"Vendor details saved successfully",
    'StatusCode': 200
}
                            

For n number of vendors, file containing vendor information with supported file formats are required for uploading. When file uploading request is made, a response is received with status message denoting the process completion

Key Example
File_type upload .xlxs & .csv file formats

Huge Item Information Upload

For huge item information upload, use this Url:

POST: https://[url]/api/profile/[ID]/itemsimport/
Example: POST: https://api.kaptiche.com/api/profile/3/itemsimport/

Response:

{
    'Status': True,
    'StatusMessage': '{} item(s) imported'.format(count),
    'errors' : errors,
    'StatusCode': 200
}
                            

For n number of items, file containing item information with supported file formats are required for uploading. When file uploading request is made, a response is received from the backend

Key Example
File_type upload .xlxs & .csv file formats

Data Extraction

Import

File Upload

For data extraction import, use this Url:

GET: https://[url]/api/model_list/
Example: GET: https://api.kaptiche.com/api/model_list/

Response:

[
    {
        "id": 1,
        "model_name": "model",
        "folder_path": "/home/jayashri/Pictures/SVN2_2020
                        /workflow_api_backend/media/templateless/model",
        "key_data": "{
            'model_name': 'model',
            'folder_path': '/home/jayashri/Pictures/SVN2_2020
                        /workflow_api_backend/media/templateless/model',
            1: {
                'pdf_path_1': '/media/templateless/model/APM INVOICE 
                            (3rd copy).pdf',
                'value_Name_1': 'APM-Maersk ',
                'co_ord_Name_1': '1,37,677,102,686',
                'value_Due Date_1': '21/09/18 ',
                'co_ord_Due Date_1': '1,379,663,426,670'
            },
            'tables': {
                'multi_page_check_table_1_1': '0',
                'model_tbl_path_table_1_1': '/media/templateless/model/
                                        APM INVOICE (3rd copy).pdf',
                'sbky_val_table_1_1': 'Item Name Desktop Keyboard Mouse DDR4 RAM AMD GPU VGA Cable HDMI Cable Operating System (Retail) Operating System (OEM) DESCRIPTION LCD 16\" Display 16\" number pad keyboard Digital Optical cable gamming mouse 4.3\" socket High radeon 64-bit x86 processor 15 pin blue cable 10m optical cable 5 year Windows 10 licence Life-time Windows 10 Licence Quantity Rate Total 6 2 2 5 2 7 5 6 4 $ 5,000.00 $30,000.00 $ 250.00 $500.00 $ 200.00 $400.00 $ 81,250.00 $406,250.00 $ 11,100.00 $22,200.00 $ 350.00 $2,450.00 $ 400.00 $2,000.00 $ 3,440.00 $20,640.00 $ 600.00 $2,400.00 ',
                'model_co_ord_table_1_1': '1,38,347,572,483'
            },
            'table_smiliar_type': '0'
        }"
    }
] 
                            

For n number of items, file containing item information with supported file formats are required for uploading. When file uploading request is made, a response is received from the backend

For data extraction import, use this Url:

POST: https://[url]/api/profile/invoice/profile/[ID]/invoice/new/
Example: POST: https://api.kaptiche.com/api/profile/invoice/profile/3/invoice/new/

Response:

{
    "Statusmessage": "File(s) uploaded successfully"
}                
                                

When file upload request is made, a request body is sent and a response is received with a status message

Key Example
Model_id 2
Invoice_file File.pdf

File Upload Invoice View

For file upload invoice view, use this Url:

GET: https://[url]/api/profile/invoice/profile/[ID]/invoice/details/
Example: https://api.kaptiche.com/api/profile/invoice/profile/3/invoice/details/

Response:

{
    "profile": {
        "id": 1,
        "user": {
            "email":
            "kapticheadmin@sensiple.com",
            "first_name": "Kaptiche",
            "last_name": "Admin",
            "username": "kapticheadmin@sensiple.com",
            "is_superuser": true,
            "is_staff": true
        },
        "group": 4 
    },
    "invoices_pending_storeuser": [],
    "invoices_pending_financialeditor": [],
    "invoices_profile": [
        {
            "id": 2,
            "state": "new",
            "requester_name": 1,
            "error_invoice": false,
            "requester_names": "Kaptiche Admin",
            "invoice_id": "INV7128O390B",
            "invoice_date": "17-02-2020 10:19:01",
            "invoice_file": "/media/invoices/kapticheadmin%40sensiple
                            .com/INV7128O390B/APM%20INVOICE%20(3rd%20
                            copy).pdf",
            "invoice_file_name": "APM INVOICE (3rd copy).pdf",
            "invoice_jsondata": "{
                'Name': ['APM-Maersk','', ''],
                'Due Date': ['21/09/18', '', '']
                }",
            "invoice_ocr_file": "/media/invoices/kapticheadmin%40sensiple
                                .com/INV7128O390B/APM%20INVOICE%20(3rd%20
                                copy).pdf",
            "barcodedata": "{'APM INVOICE (3rd copy).pdf': [None]}",
            "jsontablepath": "/home/jayashri/Pictures/SVN2_2020/workflow
                            _api_backend/media/invoices/kapticheadmin@
                            sensiple.com/INV7128O390B/json/",
            "tabledata": "[
                {   
                    \"0\": \"Item Name\",
                    \"1\": \"DESCRIPTION\",
                    \"2\": \"Quantity\",
                    \"3\": \"Rate\",
                    \"4\": \"Total\"    
                },
                {   \"0\": \"Desktop\",
                    \"1\": \"LCD 16\\\" Display\",
                    \"2\": \"6\",
                    \"3\": \"$ 5,000.00\",
                    \"4\": \"$30,000.00\"   
                }
            ]",
            "import_type": "Manual",
            "invoice_txt_file": "/media/invoices/kapticheadmin%40sensiple
                                .com/INV7128O390B/APM%20INVOICE%20(3rd%20
                                copy).txt",
            "invoice_txt_filename": "APM INVOICE (3rd copy).txt",
            "extraction_status": "Finished",
            "updated_invoice_date": "17-02-2020 10:19:01",
            "status": "Created",
            "approve_store_user": null,
            "approve_financial_editor": null,
            "rejected_store_user": null,
            "rejected_financial_editor": null,
            "audit_jsondata": "",
            "audit_table_jsondata": "",
            "confidence_level": null,
            "rejection_reason": "" 
        }
    ],
    "pk": 1,
    "invoices_store_user": [],
    "invoices_financial_editors": [],
    "invoices_pending_dict": {},
    "invoices_dict": {},
    "license_valid": true 
}                
                                

When data extracted invoice is to be viewed, a request body is sent and a response is received

Web Scanner

For web scanner, use this Url:

POST: https://[url]/api/web_scanner/
Example: POST: https://api.kaptiche.com/api/web_scanner/

Response:

{
    "data": "192.168.18.93",
    "Status": true,
    "StatusMessage": "Scanner Available",
    "StatusCode": 200
}
                            

When web scanner information is requested, a request body is sent and information is retrieved and displayed as a response

For refresh list, use this Url:

POST: https://[url]/api/scanner_refresh_list/
Example: POST: https://api.kaptiche.com/api/scanner_refresh_list/

Response:

{
    "device_list": ["hpaio:/net/HP_LaserJet_Pro_MFP_M126nw?
                    ip=192.168.45.52" ],
    "Status": true,
    "StatusMessage": "Scanner Available",
    "StatusCode": 200
}
                                

When web scanner refresh list is required, a request body is sent and information is retrieved and displayed as a response

For scanning document from scanner, use this Url:

POST: https://[url]/api/scanning_document_from_scanner/
Example: POST: https://api.kaptiche.com/api/scanning_document_from_scanner/

Response:

{
    "Status": true,
    "image_path": "http://192.168.18.93:5555/media/web_scanner
                /scanned_image_17-02-2013:05:12.jpeg",
    "pathhs": "/media/web_scanner/scanned_image_17-02-20 13:05:12.jpeg",
    "StatusCode": 200
}
                                

When file upload request is made, a request body is sent and a response is received with a status message

Key Example
Scanner Hpaio:/net
ip 168.585.54.25
format jpeg

For invoice details, use this Url:

GET: https://[url]/api/profile/[ID]/invoice/details/
Example: GET: https://api.kaptiche.com/api/profile/3/invoice/details/

Response:

{
    "profile": {
        "id": 1,
        "user": {
            "email": "kapticheadmin@sensiple.com",
            "first_name": "Kaptiche",
            "last_name": "Admin",
            "username": "kapticheadmin@sensiple.com",
            "is_superuser": true,
            "is_staff": true
        },
        "group": 4
    },
    "invoices_pending_storeuser": [],
    "invoices_pending_financialeditor": [],
    "invoices_profile": [
        {
            "id": 3,
            "state": "new",
            "requester_name": 1,
            "error_invoice": false,
            "requester_names": "Kaptiche Admin",
            "invoice_id": "INV9443W829M",
            "invoice_date": "17-02-2020 10:38:13",
            "invoice_file": "/media/invoices/kapticheadmin%40sensiple
                            .com/INV9443W829M/APM%20INVOICE%20(3rd%20
                            copy).pdf",
            "invoice_file_name": "APM INVOICE (3rd copy).pdf",
            "invoice_jsondata": "{'Name': ['APM-Maersk', '', ''],
                             'Due Date': ['21/09/18', '', '']
                            }",
            "invoice_ocr_file": "/media/invoices/kapticheadmin%40sensiple
                                .com/INV9443W829M/APM%20INVOICE%20(3rd%20
                                copy).pdf",
            "barcodedata": "{'APM INVOICE (3rd copy).pdf': [None]}",
            "jsontablepath": "/home/jayashri/Pictures/SVN2_2020/workflow_
                            api_backend/media/invoices/kapticheadmin@
                            sensiple.com/INV9443W829M/json/",
            "tabledata": "[
                {
                    \"0\": \"Item Name\",
                    \"1\": \"DESCRIPTION\",
                    \"2\": \"Quantity\",
                    \"3\": \"Rate\",
                    \"4\": \"Total\"
                },
                {   \"0\": \"Desktop\",
                    \"1\": \"LCD 16\\\" Display\",
                    \"2\": \"6\",
                    \"3\": \"$ 5,000.00\",
                    \"4\": \"$30,000.00\"
                }
            ]",
            "import_type": "Manual",
            "invoice_txt_file": "/media/invoices/kapticheadmin%40sensiple
                                .com/INV9443W829M/APM%20INVOICE%20(3rd%20
                                copy).txt",
            "invoice_txt_filename": "APM INVOICE (3rd copy).txt",
            "extraction_status": "Finished",
            "updated_invoice_date": "17-02-2020 10:38:13",
            "status": "Created",
            "approve_store_user": null,
            "approve_financial_editor": null,
            "rejected_store_user": null,
            "rejected_financial_editor": null,
            "audit_jsondata": "",
            "audit_table_jsondata": "",
            "confidence_level": null,
            "rejection_reason": ""
        }
    ],
    "pk": 1,
    "invoices_store_user": [],
    "invoices_financial_editors": [],
    "invoices_pending_dict": {},
    "invoices_dict": {},
    "license_valid": true
}
                                

When invoice detail is required, a request body is sent and response is received with all the invoice information

Export

For data extraction import, use this Url:

POST: https://[url]/api/export/
Example: POST: https://api.kaptiche.com/api/export/

Response:

{
    "res":{
    "csv_path" : csvpath,
    "json_path" : jsonpath,
    "xml_path" : xmlpath
    },
    "StatusCode":200
} 
                            

When a request is made, a request body is sent and a response is received

Key Example
Export Type .ght
Profile Id 18
Date range 2019

New Traning Model

For new traning model, use this Url:

POST: https://[url]/api/model_upload/
Example: POST: https://api.kaptiche.com/api/model_upload/

Response:

{
    "context": {
        "model_name": "Modd",
        "list_of_files_path": ["/media/templateless/Modd/2493 (1).pdf" ] 
    },
    "Statusmessage": "modelname created",
    "status": "success"
} 
                            

When a request for training model is made, a request body is sent and a response is received

Key Example
Model name NewMod
File Mod.pdf

For height finding, use this Url:

POST: https://[url]/api/mediabox_height_finder/
Example: POST: https://api.kaptiche.com/api/mediabox_height_finder/

Response:

{
    "height":"792"
}
                                

When a request is made for training model height, a request body is sent and a response is received

Key Example
Model name NewMod
File Mod.pdf

For designer extract fields, use this Url:

POST: https://[url]/api/designer_extract_fields/
Example: POST: https://api.kaptiche.com/api/designer_extract_fields/

Response:

{
    "data": {
        "coordinates": "1,32,674,95,687",
        "res": "APM-Maersk "
    }
}                                

When a request is made for providing training model information, a request body is sent and a response is received

Key Example
Model name NewMod
Field name 12.23.85
File name Mod.pdf

Edit Training Model

For edit traning model, use this Url:

POST: https://[url]/api/training_existing_data_model/
Example: POST: https://api.kaptiche.com/api/training_existing_data_model/

Response:

{
    "model_lst": [
        {
            "id": 1,
            "model_name": "model"
        }
    ],
    "Status": true,
    "StatusMessage": "Model List",
    "StatusCode": 200
}  
                            

When a request is made for providing training model information, a request body is sent and a response is received

Key Example
Id 1
Model name Mod

For edit traning existing model view, use this Url:

POST: https://[url]/api/training_existing_data_model_view/
Example: POST: https://api.kaptiche.com/api/training_existing_data_model_view/

Response:

{
    "context": {
        "pdf_name_list": [
            "APM INVOICE (3rd copy).pdf"
        ],
        "pdf_path_list": [
            "/media/templateless/model/APM INVOICE (3rd copy).pdf"
        ],
        "folder_path": "/home/jayashri/Pictures/SVN2_2020/workflow
                        _api_backend/media/templateless/model",
        "existing_data": {
            "1": {
                "pdf_path_1": "/media/templateless/model/APM INVOICE 
                                (3rd copy).pdf",
                "value_Name_1": "APM-Maersk ",
                "co_ord_Name_1": "1,37,677,102,686",
                "value_Due Date_1": "21/09/18 ",
                "co_ord_Due Date_1": "1,379,663,426,670"
            }
        },
        "model_name": "model",
        "model_id": 1,
        "table_data_value": {
            "multi_page_check_table_1_1": "0",
            "model_tbl_path_table_1_1": "/media/templateless/model/APM
                                         INVOICE (3rd copy).pdf",
            "sbky_val_table_1_1": "Item Name Desktop Keyboard Mouse DDR4 RAM AMD GPU VGA Cable HDMI Cable Operating System (Retail) Operating System (OEM) DESCRIPTION LCD 16\" Display 16\" number pad keyboard Digital Optical cable gamming mouse 4.3\" socket High radeon 64-bit x86 processor 15 pin blue cable 10m optical cable 5 year Windows 10 licence Life-time Windows 10 Licence Quantity Rate Total 6 2 2 5 2 7 5 6 4 $ 5,000.00 $30,000.00 $ 250.00 $500.00 $ 200.00 $400.00 $ 81,250.00 $406,250.00 $ 11,100.00 $22,200.00 $ 350.00 $2,450.00 $ 400.00 $2,000.00 $ 3,440.00 $20,640.00 $ 600.00 $2,400.00 ",
            "model_co_ord_table_1_1": "1,38,347,572,483"
        },
        "table_chk": 1,
        "qr_bar_chk": 1
    },
    "train_data": {
        "keys_value": [
            {
                "APM INVOICE (3rd copy).pdf": [
                    {
                        "key_name": "Name",
                        "key_value": "APM-Maersk ",
                        "coord": "1,37,677,102,686"
                    },
                    {
                        "key_name": "Due Date",
                        "key_value": "21/09/18 ",
                        "coord": "1,379,663,426,670"
                    }
                ]
            }
        ],
        "cont_table": [],
        "single_table": [
            {
                "file_name_1": "model/APM INVOICE (3rd copy).pdf",
                "table_value_1": "Item Name Desktop Keyboard Mouse DDR4 RAM AMD GPU VGA Cable HDMI Cable Operating System (Retail) Operating System (OEM) DESCRIPTION LCD 16\" Display 16\" number pad keyboard Digital Optical cable gamming mouse 4.3\" socket High radeon 64-bit x86 processor 15 pin blue cable 10m optical cable 5 year Windows 10 licence Life-time Windows 10 Licence Quantity Rate Total 6 2 2 5 2 7 5 6 4 $ 5,000.00 $30,000.00 $ 250.00 $500.00 $ 200.00 $400.00 $ 81,250.00 $406,250.00 $ 11,100.00 $22,200.00 $ 350.00 $2,450.00 $ 400.00 $2,000.00 $ 3,440.00 $20,640.00 $ 600.00 $2,400.00 ",
                "coord_1": "1,38,347,572,483"
            }
        ],
        "model_type": "new",
        "mod_name": "model",
        "QR_code_Scanner": "no",
        "url": "http://192.168.18.93:5555/kaptiche/training_data
                _model_view/model"
    },
    "Status": true,
    "Statusmessage": "Data to view",
    "StatusCode": 200
}  
                            

When a request is made for viewing existing training model, a request body is sent and a response is received and displayed

Key Example
Model Id 5
current_url http://xxx.xxx.xx.xxx:xxxx/kaptiche/training-existing-data-model

For traning file upload existing, use this Url:

POST: https://[url]/api/training_file_upload_existing/
Example: POST: https://api.kaptiche.com/api/training_file_upload_existing/

Response:

{
    "context": {
        "model_name": "model",
        "list_of_files_path": [ 
                    "/media/templateless/model/APM INVOICE (4th copy).pdf"
                    ] 
    },
    "status": true,
    "Statusmessage": "File uploaded successfully",
    "StatusCode": 200
} 
                                

When a request is made uploading file, a request body is sent and a response is received

Key Example
Model name NewMod
File Mod.pdf

Huge Upload

For bulk upload, use this Url:

POST: https://[url]/api/bulk_upload/[ID]/
Example: POST: https://api.kaptiche.com/api/bulk_upload/2/

Response:

{
    "Processed_list": [
        {
            "Filestatus": "Processed",
            "File_count": 1,
            "Modelname": "model
        }
    ],
    "status": true,
    "StatusMessage": "File Uploaded Successfully"
}  
                            

When a request is made bulk uploading of information, a request body is sent and a response is received

Key Example
File Mod.pdf

For unsorted list, use this Url:

GET: https://[url]/api/unsorted_list/[id]/
Example: GET: https://api.kaptiche.com/api/unsorted_list/2/

Response:

{
    "Unsorted_list": [
        "id":1,
        "Filestatus":"xxxx",
        "Filename":"xxx.pdf",
        "Date":"xx/xx/xx",
        "Filepath":"media/templatelessUnsortedFile/'+[id]+'/'+xxx.pdf'" 
    ],
    "status": true,
    "StatusMessage": "Unsorted File List"
}   
                            

When a request is made for viewing unsorted list, a request body is sent and project list is retrieved and displayed as a response

Advanced Search

For data extraction advanced search, use this Url:

POST: https://[url]/api/advanced_search/
Example: POST: https://api.kaptiche.com/api/advanced_search/

Response:

{
    "data":[
        {
            "invoice_id":"12",
            "invoice_file_name":"APM INVOICE (3rd copy).pdf",
            "invoice_date":"2020-02-17 06:38:29",
            "dataStatus":"true",
            "archived":"Not Archived",
            "file_path":"/media/invoices/1/APM INVOICE (3rd copy).pdf","id":1
        }
    ],
    "dataStatus":true,
    "StatusMessage":"Data available",
    "StatusCode":200
} 
                            

When a request is made for finding information using keyword, a request body is sent and a response is received

Key Example
Value 121
From Date 15/02/2020
To Date 17/02/2020

Health Care

Patient List

For getting patient list upload, use this Url:

GET: https://[url]/api/projectPost/[id]/
Example: GET: https://api.kaptiche.com/api/projectPost/3/

Response:

{
    "project_list": [
        {
            "id": 1,
            "project_name": "12"
        }
    ]
}  
                            

When a request is made for viewing project list, a request body is sent and project list is retrieved and displayed as a response

Patient Create

For create patient list, use this Url:

POST: https://[url]/api/projectPost/[id]/
Example: POST: https://api.kaptiche.com/api/projectPost/3/

Response:

{
    "Statusmessage": "Patient ID Created Successfully",
    "Status": true,
    "StatusCode": 200
}   
                            

When a request is made for creating project id, a request body is sent and project id is created as a response

Key Example
Project name Mod.pdf

Patient List in Patient Page

For patient list, use this Url:

GET: https://[url]/api/projectlist/
Example: GET: https://api.kaptiche.com/api/projectlist/

Response:

{
    "project_list": [
        {
            "id": 1,
            "project_name": "12"
        },
        { 
            "id": 2,
            "project_name": "dddd"
        },
        {
            "id": 3,
            "project_name": "ddd"
        }
    ]
}    
                            

When a request is made for viewing patient list, a request body is sent and patient list is retrieved and displayed as a response

Patient File Upload

For patient file upload, use this Url:

POST: https://[url]/api/get_folder_and_files/
Example: POST: https://api.kaptiche.com/api/get_folder_and_files/

Response:

{
    "folder_structure": {
        "folders_list": [
            {
                "name": "sssss",
                "type": "folder"
            }
        ],
        "files_list": [
            {
                "name": "APM INVOICE (3rd copy).pdf",
                "type": "pdf",
                "path": "/media/invoices/1/APM INVOICE (3rd copy).pdf"
            }
        ]
    }
}   
                            

When a request is made for uploading patient file, a request body is sent and patient file is uploaded as a response

Patient File Upload Advance Search

For patient file upload advance search, use this Url:

POST: https://[url]/api/advanced_search_patient/
Example: POST: https://api.kaptiche.com/api/advanced_search_patient/

Response:

{
    "data":[
        {
            "invoice_id":"12",
            "invoice_file_name":"APM INVOICE (3rd copy).pdf",
            "invoice_date":"2020-02-17 06:38:29",
            "dataStatus":"true",
            "archived":"Not Archived",
            "file_path":"/media/invoices/1/APM INVOICE (3rd copy).pdf",
            "id":1
        }
    ],
    "dataStatus":true,
    "StatusMessage":"Data available",
    "StatusCode":200
}   
                            

When a request is made for finding patient file, a request body is sent and the file is retrieved and displayed as response

Key Example
Value 121
From Date 15/02/2020
To Date 17/02/2020

Patient File Upload(Add new File and Folder)

For add new file and folder, use this Url:

POST: https://[url]/api/create_folder/
Example: POST: https://api.kaptiche.com/api/create_folder/

Response:

{
    "folder_structure": {
        "folders_list": [
            "sss", "sdsd" 
        ],
        "files_list": [
            "APM INVOICE (6th copy).pdf"
        ]
    }
}    
                            

When a request is made for adding new file and new folder, a request body is sent and new folder and new file are created as response

Key Example
Folder Path home/patient/dis
Folder Name PatientInfo

Patient File(Advance Search)

For advance search, use this Url:

POST: https://[url]/api/advanced_search_patient/
Example: POST: https://api.kaptiche.com/api/advanced_search_patient/

Response:

{
    "data":[
        {
            "invoice_id":"12",
            "invoice_file_name":"APM INVOICE (3rd copy).pdf",
            "invoice_date":"2020-02-17 06:38:29",
            "dataStatus":"true",
            "archived":"Not Archived",
            "file_path":"/media/invoices/1/APM INVOICE (3rd copy).pdf",
            "id":1
        }
    ],
    "dataStatus":true,
    "StatusMessage":"Data available",
    "StatusCode":200
}    
                            

When a request is made for quick search of patient file, a request body is sent and the file is retrieved and displayed as response

Key Example
Value 121
From Date 15/02/2020
To Date 17/02/2020

Patient Archive

For patient archive, use this Url:

GET: https://[url]/api/project_list/
Example: GET: https://api.kaptiche.com/api/project_list/

Response:

{
    "archived_project_list": [
        {
            "id": 1,
            "project_name": "12",
            "archive_type": "soft"
        }
    ],
    "Listpro": [
        {
            "id": 2,
            "project_name": "dddd"
        },
        {
            "id": 3,
            "project_name": "ddd"
        }
    ],
    "Statusmessage": "Archived successfully",
    "Status": true,
    "StatusCode": 200
}    
                            

When a request is made for archiving patient information, a request body is sent and a response is received

For patient archive, use this Url:

POST: https://[url]/api/archive/
Example: POST: https://api.kaptiche.com/api/archive/

Response:

{
    "Statusmessage":"Patient detail archived successfully",
    'Status': True,
    'StatusCode': 200
}                             

When a request is made for archiving patient information, a request body is sent and a response is received

Key Example
Patient Id 125

For retrive, use this Url:

POST: https://[url]/api/retrive/
Example: POST: https://api.kaptiche.com/api/retrive/

Response:

{
    "Statusmessage":"Patient detail retrived successfully",
    "Status":true,
    "StatusCode":200
}                             

When a request is made for retrieving patient information, a request body is sent and a response is received