-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get Rate Limiting Info
-
-
Consumer
-
The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on beMore...
- Set Rate Limits / Call Limits per Consumer
-
v5.1.0 filtered by tag: Rate-Limits (2 APIs)
Anfitrión de la API: https://api.ttk.com.mk
Banco
Cuentas
Vistas
Contrapartes
Transacciones
Get Rate Limiting Info
Get information about the Rate Limiting setup on this OBP Instance such as:
Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).
Note: Rate limiting can be set at the Consumer level and also for anonymous calls.
See the consumer rate limits / call limits endpoints.
Authentication is Mandatory
JSON response body fields:
enabled: false
is_active: false
technology: technology1
Respuesta Exitosa Típica:
{
"enabled":true,
"technology":"REDIS",
"service_available":true,
"is_active":true
}
Validaciones:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Posibles Errores:
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Métodos de conector::
Version: OBPv3.1.0,
function_name: by getRateLimitingInfo, operation_id: OBPv3.1.0-getRateLimitingInfo
Tags: API, Rate-Limits,
Set Rate Limits / Call Limits per Consumer
Set the API rate limits / call limits for a Consumer:
Rate limiting can be set:
Per Second
Per Minute
Per Hour
Per Week
Per Month
Authentication is Mandatory
URL Parameters:
CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
api_name: api_name
bank_id: gh.29.uk
Respuesta Exitosa Típica:
{
"from_date":"1100-01-01T00:00:00Z",
"to_date":"1100-01-01T00:00:00Z",
"per_second_call_limit":"-1",
"per_minute_call_limit":"-1",
"per_hour_call_limit":"-1",
"per_day_call_limit":"-1",
"per_week_call_limit":"-1",
"per_month_call_limit":"-1"
}
Roles Requeridos:
-
CanSetCallLimits
- Please login to request this Role
Validaciones:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Posibles Errores:
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
- OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30023: Cannot update Consumer
- OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0,
function_name: by callsLimit, operation_id: OBPv4.0.0-callsLimit
Tags: Consumer, Rate-Limits,