right logo image
right logo image
Log on
⯆

API Explorer

Log off

v3.1 (83 APIs)

API Host: https://api.ttk.com.mk
Bank
Accounts
Views
Counterparties
Transactions

Create User

Create User

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/save"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "id":1,
  "first_name":"string",
  "last_name":"string",
  "age":1,
  "career":"string"
}
Required Roles:
  • CanCreateDynamicEndpoint_User469 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_save, operation_id: OBPv4.0.0-dynamicEndpoint_POST_save Tags: Example Title, Dynamic-Endpoint, Dynamic,

Delete User

Delete user by user ID

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/delete/{userId}"
    },
    {
        "key":"http_method",
        "value":"DELETE"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
"the successful delete user by user ID"
Required Roles:
  • CanDeleteDynamicEndpoint_User972 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_DELETE_delete_USER_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_delete_USER_ID Tags: Example Title, Dynamic-Endpoint, Dynamic,

Get User

Get reuested user by user ID

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/getById/{userId}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "id":1,
  "first_name":"string",
  "last_name":"string",
  "age":1,
  "career":"string"
}
Required Roles:
  • CanGetDynamicEndpoint_User202 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_getById_USER_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_getById_USER_ID Tags: Example Title, Dynamic-Endpoint, Dynamic,

Get Users

Get list of users

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/listUsers"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
[{
  "id":1,
  "first_name":"string",
  "last_name":"string",
  "age":1,
  "career":"string"
}]
Required Roles:
  • CanGetDynamicEndpoint_Users187 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_listUsers, operation_id: OBPv4.0.0-dynamicEndpoint_GET_listUsers Tags: Example Title, Dynamic-Endpoint, Dynamic,

Update User

Update User

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/updateUser"
    },
    {
        "key":"http_method",
        "value":"PUT"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Typical Successful Response: 

								
									
{
  "id":1,
  "first_name":"string",
  "last_name":"string",
  "age":1,
  "career":"string"
}
Required Roles:
  • CanUpdateDynamicEndpoint_User114 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_PUT_updateUser, operation_id: OBPv4.0.0-dynamicEndpoint_PUT_updateUser Tags: Example Title, Dynamic-Endpoint, Dynamic,