RafaelRuiz
/
assistance-engine
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(core): add official AVAP documentation in Markdown

This commit is contained in:
rafa-ruiz 2026-03-04 18:25:15 -08:00
parent 86f426ae48
commit 2d66266fd8
593 changed files with 40445 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

735
docs/AVAP Language: Core Commands & Functional Specification/AVAP.md Normal file
View File

@ -0,0 +1,735 @@
# SECTION I: Architecture, Memory, and Fundamentals
This section sets the foundations of how AVAP manages service logic and data manipulation in memory. Unlike conventional interpreted languages, AVAP uses a **hybrid evaluation** engine that allows combining declarative commands with dynamic expressions.
---
## 1.1 Endpoint Registration (`registerEndpoint`)
The `registerEndpoint` command is the atomic unit of configuration. It acts as the bridge between the network (HTTP) and the code.
### Interface
`registerEndpoint(path, method, middleware, description, handler, output)`
### Parameter Specification
- **`path` (String):** Defines the URL path. It supports static routes and is prepared for future implementations of path parameters (variable segments).
- **`method` (String):** Specifies the allowed HTTP verb (`GET`, `POST`, `PUT`, `DELETE`). The server will automatically reject any request that does not match this method (Error 405).
- **`middleware` (List):** A list of functions that are executed sequentially before the `handler`. Ideal for JWT token validations or maintenance checks. If a middleware function fails, the flow stops before reaching the main code.
- **`description` (String):** Metadata for automatic documentation (Swagger/OpenAPI). It does not affect execution but is vital for the development lifecycle.
- **`handler` (Function):** The logical Entry Point. It is the name of the main function where the business logic resides.
- **`output` (Variable):** Defines the "master" variable that the engine will automatically return upon completion, unless additional results are specified via `addResult`.
---
## 1.2 Variable Assignment Engine (Dynamic Assignment)
AVAP allows a direct assignment syntax using the `=` symbol, which grants flexibility similar to languages like Python, but under strict context control.
### Internal Mechanics: The `eval` Process
When the interpreter finds an instruction of the type `variable = expression`, it activates a three-step process:
1. **Cleaning and Tokenization:** The engine identifies if the expression contains references to existing variables (using `$`), method calls, or literals.
2. **Expression Evaluation:** Operations are resolved in real-time. This allows:
- **Boolean Logic:** `is_valid = (age > 18 and has_permission == True)`.
- **Arithmetic:** `tax = subtotal * 0.21`.
- **String Formatting:** `query = "SELECT * FROM users WHERE id = %s" % recovered_id`.
3. **Object and Property Resolution:** Allows deep access to complex structures returned by database connectors or APIs: `client_email = user_list[0].profile.email`.
### Effect on Memory
Unlike `addVar`, dynamic assignment is capable of transforming the variable type on the fly (Mutable Type System). If a variable contained a number and is assigned a string after evaluation, the engine updates the variable metadata automatically.
---
## 1.3 State Initialization and References (`addVar`)
`addVar` is the fundamental command to define the global state of the script.
### Interface
`addVar(targetVarName, varValue)`
### Advanced Behavior
- **Intelligent Automatic Typing:** The engine inspects `varValue`. If it detects a numerical format (even if it comes as a string from configuration), it will internally convert it to `int` or `float`. It supports the use of commas and periods interchangeably, normalizing the value for mathematical operations.
- **The Reference Prefix `$`:** This is the dereferencing operator.
- `addVar(copy, $original)`: Indicates to the engine that it should not assign the string "$original", but look in the symbol table for the current value of the variable `original` and copy it.
- **Scope:** Variables created with `addVar` in the main body of the script are considered **Request Session Variables**, meaning they live during the entire execution lifecycle of that specific API call, but are isolated from other concurrent requests to guarantee data security (Thread-Safety).
| **Syntax** | **Usage** | **Description** |
| :--- | :--- | :--- |
| `name = "Juan"` | Direct Assignment | Creates a simple text string. |
| `total = $price * 1.10` | Dynamic Evaluation | Uses the value of `price` for a calculation and saves the result. |
| `addVar(status, 200)` | Initialization | Explicit method to ensure creation in the global context. |
| `data = res[0].info` | Object Access | Extracts a specific property from a JSON object or DB result. |
---
# SECTION II: Input and Output (I/O) Management
This section describes the mechanisms that AVAP uses for external data ingestion, parameter integrity validation, and constructing the response package that will be delivered to the final client.
---
## 2.1 Intelligent Parameter Capture (`addParam`)
The `addParam` command is the component in charge of extracting information from the incoming HTTP request. Its design is **source-agnostic**, which simplifies development by not requiring the programmer to specify where the data comes from.
### Interface
`addParam(param_name, target_variable)`
### Priority Mechanics (Cascading Search)
When `addParam` is invoked, the AVAP engine inspects the request in the following hierarchical order:
1. **Query Arguments:** Parameters present in the URL (e.g., `?id=123`).
2. **JSON Body:** If the request has a `Content-Type: application/json`, it looks for the key inside the JSON object.
3. **Form Data / Body Arguments:** Data sent via standard forms (`x-www-form-urlencoded`).
### Technical Behavior
- **Automatic Decoding:** The engine attempts to decode values to ASCII/UTF-8 format, eliminating encoding inconsistencies.
- **Null Treatment:** If the requested parameter does not exist in any of the sources, the target variable (`target_variable`) is initialized as `None`. This allows performing subsequent security checks via `if` blocks.
---
## 2.2 Validation and Collection Counting (`getListLen`)
To guarantee that an API is robust, it is necessary to validate how much information has been received. `getListLen` acts as AVAP's volume inspector.
### Interface
`getListLen(source_variable, target_variable)`
### I/O Applications
- **Parameter Validation:** Allows counting how many elements a variable contains that has been populated by `addParam` or `getQueryParamList`.
- **Loop Security:** Before starting a `startLoop`, it is recommended to use `getListLen` to define the upper limit of the cycle, avoiding overflow errors.
- **Database Results:** After a query, it determines if records were obtained (length > 0) or if the query resulted empty.
---
## 2.3 Multiple List Capture (`getQueryParamList`)
Scenarios exist where the same parameter is sent several times (e.g., search filters like `?color=red&color=blue`). AVAP manages this through a specialized capture in lists.
### Interface
`getQueryParamList(param_name, target_list_variable)`
### Effect
Transforms all occurrences of `param_name` into a structured list inside `target_list_variable`. If there is only one value, it creates a single-element list. This ensures that subsequent logic can always treat the data as a collection, avoiding type errors.
---
## 2.4 Construction of the Response (`addResult`)
The `addResult` command is in charge of registering which variables will be part of the response body. AVAP dynamically constructs a JSON output object based on calls to this command.
### Interface
`addResult(source_variable)`
### Advanced Features
- **Promise Management:** If the variable passed to `addResult` is the result of an operation initiated with `go_async`, the engine will automatically mark that field as `"promised"` in the response, or return the thread ID if synchronization has not completed.
- **String Cleaning:** The engine detects if the content of the variable has redundant quotes (product of previous evaluations) and normalizes them to ensure that the resulting JSON is valid and clean.
- **Multi-Registration:** Multiple calls to `addResult` can be made. Each call adds a new key to the output JSON object. By default, the key in the JSON will be the variable name, unless a custom key is used in the engine.
---
## 2.5 HTTP Status Control (`_status`)
AVAP uses a reserved system variable to communicate with the underlying web server and define the success or error code of the transaction.
### Use of `_status`
When assigning a numerical value to the `_status` variable (using `addVar` or direct assignment), the programmer defines the HTTP code of the response.
| **Code** | **Common Use in AVAP** |
| :--- | :--- |
| **200** | Successful operation (Default value). |
| **201** | Resource successfully created. |
| **400** | Parameter validation error (Bad Request). |
| **401** | Authentication failure. |
| **500** | Internal error captured in an `exception` block. |
### Section II Integrated Example
```
// We capture input
addParam("user_id", id)
// We validate presence
if(id, None, '==')
addVar(_status, 400)
addVar(error, "The user ID is mandatory")
addResult(error)
return()
end()
// If we reach here, we respond with success
addVar(_status, 200)
addResult(id)
```
---
# SECTION III: Control Logic and Decision Structures
This section details how AVAP manages execution flow. The language uses closed block structures that allow for a clear sequential reading, facilitating the debugging of complex APIs.
---
## 3.1 The Conditional Block (`if / else / end`)
The `if` structure in AVAP is a versatile tool that allows for atomic comparisons or the evaluation of complex logical expressions processed by the dynamic evaluation engine.
### Standard Interface
`if(variable_A, valor_B, operador)`
### Available Operators
| **Operator** | **Description** | **Example** |
| :--- | :--- | :--- |
| `=` | Strict equality (or numerical equivalence). | `if(rol, "admin", "=")` |
| `!=` | Inequality. | `if(status, 200, "!=")` |
| `>` / `<` | Numerical magnitude comparison. | `if(edad, 18, ">")` |
| `in` | Checks if an element belongs to a list or string. | `if(user, lista_negra, "in")` |
### Evaluation of Complex Expressions
AVAP allows omitting comparison parameters to evaluate a complete logical expression directly in the third parameter.
- **Example:** `if(None, None, "age >= 18 and balance > 100")`.
### Closing Structure
Every `if` block can include an optional `else()` block and **must** end with the `end()` command.
---
## 3.2 Iterations and Loops (`startLoop / endLoop`)
For the processing of collections (like database rows or parameter lists), AVAP implements a repetition cycle controlled by indices.
### Interface
`startLoop(contador, inicio, fin)`
### Execution Mechanics
1. **Initialization:** The engine creates the `contador` variable with the value of `inicio`.
2. **Increment:** In each turn, the counter increases automatically by 1 unit.
3. **Exit Condition:** The loop stops when the `contador` exceeds the value of `fin`.
### Practical Example: List Processing
```
// We obtain the length of a list captured in Section II
getListLen(items_received, total)
startLoop(i, 0, total)
current_item = items_received[i]
// Processing logic for each item...
endLoop()
```
---
## 3.3 Error Management and Robustness (`try / exception`)
AVAP is a language designed for production environments where external failures (database timeout, down third-party APIs) are a reality. The `try` block allows capturing these events without stopping the server.
### Interface
`try` ... `exception(error_variable)` ... `end()`
### Technical Operation
- **`try` Block:** The engine attempts to execute the instructions contained within. If a critical failure occurs, it stops execution of that block immediately.
- **`exception` Block:** If an error is detected, control passes to this block. The `error_variable` is automatically populated with a string describing the failure (simplified Stack trace).
- **`end()` Block:** Closes the structure and allows the script to continue its normal execution after the error handling.
### Example of Security in Connectors
```
try
// We attempt a query to an external connector (Section V)
resultado = db.query("SELECT * FROM pagos")
exception(failure_detail)
// If it fails, we log the error and notify
addVar(_status, 500)
addVar(message, "Persistence error: %s" % failure_detail)
addResult(message)
end()
```
---
## 3.4 Premature Exit Control (`return`)
The `return()` command is a control instruction that immediately terminates the execution of the current context (be it a function or the main script).
- If used within a **function**, it returns control (and optionally a value) to the caller.
- If used in the **main flow**, it ends execution of the API and triggers the automatic sending of the JSON response built up to that moment.
---
**Summary of Section III:** With these structures, the AVAP programmer has total control over the dynamic behavior of the code. The combination of **Dynamic Evaluation (Section I)**, **Data Validation (Section II)** and **Control Structures (Section III)** allows for building extremely complex and secure microservices.
# SECTION IV: Concurrency and Asynchrony
AVAP implements a concurrency model based on threads that allows for "fire-and-forget" or parallel execution with subsequent synchronization. This is fundamental for tasks like sending emails, processing logs or querying multiple external APIs simultaneously.
---
## 4.1 Launching Background Processes (`go_async`)
The command `go_async` extracts a block of code from the main sequential flow and places it in a parallel execution queue.
### Interface
`go_async(thread_id)`
### Execution Mechanics
1. **Identification:** The programmer assigns a `thread_id` (a string or variable) to be able to reference that process later.
2. **Bifurcation (Forking):** As soon as it is invoked, the AVAP engine creates a new native thread. The main flow immediately continues to the next instruction after the `go_async` block.
3. **Context Isolation:** The asynchronous thread inherits a copy of the state of the variables at the moment of firing, allowing it to work safely without interfering with the main thread.
### Example: Immediate Response with Long Process
```
addParam("email", destination)
go_async("email_delivery")
// This block takes 5 seconds, but the API does not wait
email_service.send(destination, "Welcome to AVAP")
end()
addVar(msg, "Your email is being processed in the background")
addResult(msg)
// The client receives the response in milliseconds
```
---
## 4.2 Result Synchronization (`gather`)
When the main flow needs data generated by an asynchronous thread to continue, the `gather` synchronization mechanism is used.
### Interface
`gather(thread_id, timeout)`
### Specifications
- **`thread_id`:** The identifier used in the `go_async` command.
- **`timeout` (Seconds):** Maximum time that the main thread will wait. If the thread does not finish in this time, AVAP launches an exception that can be captured (Section III).
### Technical Behavior
- **Controlled Blocking:** The main thread stops (suspends) until the `thread_id` thread finishes.
- **State Recovery:** Once synchronized, any variable modified inside the asynchronous thread is fused with the context of the main thread.
---
## 4.3 Optimized Parallel Execution (Fan-Out Pattern)
AVAP allows launching multiple threads and then waiting for all of them, reducing total execution time to the time of the slowest thread, instead of the sum of all.
### Example: Querying multiple databases
```
go_async("db_north")
data_north = connector_north.query("SELECT...")
end()
go_async("db_south")
data_south = connector_south.query("SELECT...")
end()
// We wait for both (Maximum 10 seconds)
gather("db_north", 10)
gather("db_south", 10)
// We combine results using Section I
total_result = data_north + data_south
addResult(total_result)
```
---
## 4.4 Status of Promises in the Output
As mentioned in **Section II**, if a variable that is still being processed in an asynchronous thread is sent to `addResult`, AVAP manages the response intelligently:
- **If the thread still runs:** The output JSON will show `"variable": "promised"` or the thread ID.
- **If the thread failed:** The error will be registered in the internal log and the variable will be `None`.
- **If `gather` was used before `addResult`:** The real processed value will be sent.
# SECTION V: Persistence, Connectors and Native ORM
AVAP is designed to be database agnostic. It allows data manipulation through three layers: the universal connector, simplified ORM commands and direct SQL execution.
---
## 5.1 The Universal Connector (`avapConnector`)
The `avapConnector` command is the starting point for any external integration. It uses a system of **Connection Tokens** (Base64) that encapsulate the configuration (host, port, credentials, driver) to keep the code clean and safe.
### Interface
`connector_variable = avapConnector("BASE64_TOKEN")`
### Characteristics of Connector Objects
Once the variable is instantiated, it behaves as an object with dynamic methods:
- **DB Connectors:** Expose the `.query(sql_string)` method, which returns objects or lists according to the result.
- **API Connectors (Twilio, Slack, etc.):** Expose native methods of the service (e.g., `.send_sms()`).
### Example: Use of Dynamic Assignment with Connectors
```
// We instantiate the connection
db = avapConnector("REJfQ09OTkVDVE9SR...")
// We execute and use Section I to filter on the fly
users = db.query("SELECT * FROM users")
first_admin = users[0].name if users[0].role == 'admin' else 'N/A'
addResult(first_admin)
```
---
## 5.2 Native ORM Layer (`ormCheckTable` / `ormDirect`)
For quick operations on the local or default database cluster, AVAP offers system-level commands that do not require prior instantiation.
### 5.2.1 `ormCheckTable`
Verifies the existence of a structure in the database. It is vital for installation scripts or automatic migrations.
- **Interface:** `ormCheckTable(table_name, target_var)`
- **Response:** The `target_var` will receive the string values `"True"` or `"False"`.
### 5.2.2 `ormDirect`
Executes SQL commands directly. It differs from `.query()` in that it is optimized for statements that do not necessarily return rows (like `INSERT`, `UPDATE` or `CREATE TABLE`).
- **Interface:** `ormDirect(statement, target_var)`
- **Use of Interpolation:** `ormDirect("UPDATE users SET login = '%s' WHERE id = %s" % (now, id), result)`
---
## 5.3 Data Access Abstraction (Implicit Commands)
AVAP includes specialized commands for the most common CRUD operations, reducing the need to write manual SQL and mitigating injection risks.
### `ormAccessSelect`
Performs filtered queries returning a structure of object lists.
- **Syntax:** `ormAccessSelect(table, filters, target)`
### `ormAccessInsert` / `ormAccessUpdate`
Manages data persistence. If used on an object that already has an ID, `Update` synchronizes changes; otherwise, `Insert` creates the record.
---
## 5.4 Dynamic Query Formatting (Anti-Injection)
As detailed in **Section I**, the AVAP engine processes SQL strings before sending them to the database engine. The official recommendation is to always use interpolation using the `%` operator to ensure that data types (Strings vs Integers) are correctly treated by the driver.
```
// Safe and Recommended Way
sql = "SELECT * FROM %s WHERE status = '%s'" % (table_name, status_recovered)
res = db.query(sql)
```
---
## 5.5 Cryptographic Security Integration (`encodeSHA256`)
In the persistence flow, AVAP provides native tools to secure sensitive data before it touches the disk.
### Interface
`encodeSHA256(source_text, target_variable)`
### Full Registration Flow (Final Example)
This example joins **Sections I, II, III and V**:
```
// II: Capture
addParam("pass", p)
addParam("user", u)
// I and V: Processing and Security
encodeSHA256(p, secure_pass)
// V: Insertion
sql = "INSERT INTO users (username, password) VALUES ('%s', '%s')" % (u, secure_pass)
ormDirect(sql, db_result)
// III and II: Response
if(db_result, "Success", "=")
addVar(msg, "User created")
addResult(msg)
end()
```
# SECTION VI: System Utilities and Transformation
This section documents the native commands for advanced string manipulation, precise time handling and generation of dynamic data.
---
## 6.1 Time and Date Management (`getDateTime` / `stampToDatetime`)
AVAP handles time in two ways: as **Epoch/Timestamp** (numerical, ideal for calculations) and as **Datetime** (formatted text, ideal for humans and databases).
### 6.1.1 `getDateTime`
Generates current time with high precision.
- **Interface:** `getDateTime(format, timeDelta, timeZone, targetVar)`
- **Parameters:**
- `format`: Ej: `"%Y-%m-%d %H:%M:%S"`. If left empty, returns the current Epoch.
- `timeDelta`: Seconds to add (positive) or subtract (negative). Very useful for calculating token expiration.
- `timeZone`: Time zone region (ej: "Europe/Madrid").
### 6.1.2 `stampToDatetime`
Converts a numerical value (Unix Timestamp) into a legible text string.
- **Interface:** `stampToDatetime(timestamp, format, offset, targetVar)`
- **Common use:** Formatting dates recovered from the database (Section V) before sending them to the client (Section II).
---
## 6.2 Advanced String Manipulation (`replace` / `randomString`)
### 6.2.1 `replace`
Allows for cleaning and transformation of texts. It is fundamental when data is received from the client that requires sanitization.
- **Interface:** `replace(sourceText, oldText, newText, targetVar)`
- **Example:** Cleaning spaces or unwanted characters in a username before a SQL query.
### 6.2.2 `randomString`
Generates secure random alphanumeric strings.
- **Interface:** `randomString(length, targetVar)`
- **Applications:** Generation of temporary passwords, session IDs or unique file names.
---
## 6.3 Security and Hash Operations (`encodeSHA256`)
Although mentioned in persistence, its use is a data transformation utility.
- **Mechanics:** It is a deterministic one-way function.
- **Important:** AVAP uses an optimized implementation that guarantees that the same text always produces the same hash, allowing secure "login" comparisons without knowing the real password.
---
## 6.4 The Value Return Command (`return`)
In the context of functions and flows, `return` not only stops execution, but can "inject" the result of a sub-routine into the main flow.
### Example of complete utility flow:
```
// 1. We generate a temporary token
randomString(16, token_raw)
// 2. We calculate expiration (within 1 hour = 3600 seg)
getDateTime("%Y-%m-%d %H:%M:%S", 3600, "UTC", expiration_date)
// 3. We format a system message using Section I
message = "Your token %s expires on %s" % (token_raw, expiration_date)
// 4. We send to the client (Section II)
addResult(message)
```
---
## 6.5 Table of Common Formats (Cheat Sheet)
| **Token** | **Description** | **Example** |
| :--- | :--- | :--- |
| `%Y` | Full year | 2026 |
| `%m` | Month (01-12) | 02 |
| `%d` | Day (01-31) | 23 |
| `%H` | Hour (00-23) | 21 |
| `%M` | Minute (00-59) | 45 |
# SECTION VII: Function Architecture and Scopes
This section details how to encapsulate reusable logic and how AVAP manages isolated memory to avoid side effects between different parts of the program.
---
## 7.1 Definition and Declaration (`function`)
A function in AVAP is an independent block of code that is registered in the engine to be invoked at any moment.
### Interface
`function function_name(argument1, argument2, ...){ ... }`
### Technical Characteristics:
- **Local Scope (`function_local_vars`):** Upon entering a function, AVAP creates a new dictionary of local variables. Variables created within (ej. `temp = 10`) do not exist outside the function, protecting global state.
- **Context Inheritance:** Functions can read global variables using the `$` prefix, but any new assignment (`=`) will remain in local scope unless a global persistence command is used.
---
## 7.2 The Exit Command (`return`)
It is the mechanism to finalize function execution and, optionally, send a value back to the caller.
### Interface
`return(variable_or_value)`
### Behavior:
1. **Finalization:** Immediately stops processing of the function.
2. **Data Transfer:** The value passed to the `return` is injected into the variable that performed the call in the main flow.
3. **Cleaning:** Once `return` is executed, the dictionary of local variables of that function is destroyed to free memory.
---
## 7.3 Invocation and Parameter Passing
Functions are called by their name followed by the values or variables they require.
### Example of Professional Implementation:
```
// Function Definition (Local Scope)
function calculate_discount(base_price, percentage){
factor = percentage / 100
discount = base_price * factor
total = base_price - discount
return(total)
}
// Main Flow (Global Scope)
addVar(pvp, 150)
// Call to the function passing a reference $ and a literal value
final_price = calculate_discount($pvp, 20)
addResult(final_price) // Result: 120
```
---
## 7.4 Functions as Middlewares
In the `registerEndpoint` command (Section I), the `middleware` parameter accepts a list of functions. These functions have special behavior:
- If a middleware executes a `return()` without a value or with an error value, AVAP can be configured to abort the request before reaching the main `handler`.
- They are ideal for **Guard** tasks:
- API Key verification.
- Data schema validation.
- Initial audit registration (logs).
---
## 7.5 Recursivity and Limits
AVAP allows recursivity (a function calling itself), but caution is recommended regarding stack depth for asynchronous processes (Section IV). To process large data volumes, the use of `startLoop` (Section III) is always preferable.

155
docs/developer.avapframework.com/0_Accesos_EN_Accesos_EN.md Normal file
View File

@ -0,0 +1,155 @@
This document will deal with the different types of accesses that exist on
the platform.
To identify the user who owns the account where the operation is going to
be carried out, it is necessary to indicate a session identifier (
session_id parameter) or sign the call with its private key
( signature parameter). In this way, these two calls to
service are equivalent for all intents and purposes. For those cases in
which there is no pademobile user as executor of the operation, the call
with private key must be used:
* With session ID
```javascript
user_id=457&country_code=MX&comando=listado&idioma=en-us&id_canal=1&session_id=9bb19a6c0a607cb8f1791207395366d6
```
Session sample
The session_id parameter is obtained from the call to the login service:
```javascript
http://desarrollo.pademobile.com:5007/ws/users.py/login?country_code=MX&nick=test_user&pin=0000
```
```javascript
{ {' '}
"status"
:{' '}
true
,
"e_mail"
:{' '}
""
,
"elapsed"
:{' '}
0.2370758056640625
,
"certification_data"
: <certification_data>
,
"session_id"
:{' '}
"97c4abb925c9b2046ac7432762ad1417"
,
"user_type"
:{' '}
"User b\u00e1sico"
,
"profile_id"
:{' '}
1
,
"profile_code"
:{' '}
"USER"
,
"user_id"
:{' '}
225
,
"state"
:{' '}
"Distrito Federal"
,
"phone_longitude"
:{' '}
10
,
"menu"
: <lista_acciones_menu>
,
"affiliate_user_id"
:{' '}
412
,
"currency"
:{' '}
"MXN"
,
"name"
:{' '}
"Test User"
,
"certification"
:{' '}
false
,
"phone"
:{' '}
"5012385006"
}
```
* With signature
```javascript
user_id=457&country_code=MX&comando=listado&idioma=en-us&id_canal=1&signature=cc30e3efc7159bb10b910512ca441664c1578a4d
```
Signed sample
In this case an extra parameter is added to the entire original query
string. This parameter will be a hash (HMAC) of the previous
string, so any alteration in the parameters will cause the signed login
process to fail.
This process follows these steps:
* The private key of the user identified by the user_id parameter is obtained.
* The querystringis separated from the signature parameter.
* The hash is calculated using the strings obtained in steps 1 and 2.
* If the hash obtained in the previous step and the one reported in the signature parameter are the same, the login with signature is successful and the service code is executed. Otherwise an exception is thrown.
The following Python code snippet returns the querystringprovided in the
string parameter of the calculate_signature function with the signature
parameter appended to the end.{' '}
This process follows the these steps:
* The private key of the user identified by the user_id parameter is obtained.
* The querystringis separated from the signature parameter.
* The hash is calculated using the strings obtained in steps 1 and 2.
* If the hash obtained in the previous step and the one reported in the signature parameter are the same, the login with signature is successful and the service code is executed. Otherwise an exception is thrown.
```javascript
import hashlib
import hashlib
import hmac
def{' '}
calcular_firma
(Private key
, chain
)
:
signature = hmac
.new
(Private key
, chain
, hashlib
.sha1
)
.hexdigest
(
)
return chain{' '}
+{' '}
'&signature='{' '}
+ signature
```

0
docs/developer.avapframework.com/0_Administrar_solicitudes_KYC_(POST)_EN_Administrar_solicitudes_KYC_(POST)_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Agregar_usuarios_a_la_comunidad_de_un_afiliado_EN_Agregar_usuarios_a_la_comunidad_de_un_afiliado_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Alta_Admin_EN_Alta_Admin_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Aprobar_solicitudes_KYC_EN_Aprobar_solicitudes_KYC_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Chat_Operador_EN_Chat_Operador_EN.md Normal file
View File

380
docs/developer.avapframework.com/0_Ciphered_Nodes_EN_Ciphered_Nodes_EN.md Normal file
View File

@ -0,0 +1,380 @@
101OBeX offers the possibility of working with encrypted nodes or
projects. All services that are exposed through the API Manager can be
consumed in an encrypted manner, provided this preference is established
during project creation.
IT IS IMPORTANT TO UNDERSTAND THAT ONCE A PROJECT IS CREATED, THIS
ENCRYPTION SETTING CANNOT BE ALTERED. THEREFORE, IT IS CRITICAL TO
CAREFULLY CONSIDER WHETHER YOUR PROJECT REQUIRES ENCRYPTION TO AVOID
SUBSEQUENT DATA LOSS.
When you indicate that you want to be able to consume an encrypted
project, you will be assigned an encryption key for it (cipher
key) which can be consulted in the project data.
Once this key has been obtained, the calls can be encrypted under the
AES256 algorithm with said key and the response will be encrypted with the
same encryption key.
The nomenclature of the calls will be as follows:
The nomenclature of the calls will be as follows.
Decrypted call:
```javascript
https://api.101obex.com:8000/servicio?parameters
```
Encrypted call:
```javascript
https://api.101obex.com:5000/servicio?encripted_data=(encripted
parameters)
```
This adds an additional encryption layer that guarantees the security of
the transferred data.
The response will be encrypted and its morphology will be as detailed
below
Decrypted answer:
```javascript
{
"status"
:
true
,
"e_mail"
:
"test.user@waynnovate.com"
,
"elapsed"
:
0.18008685111999512
,
"datos_certificacion"
:
{
"codtran"
:
"0075f16df4b053a5d10502ffb01e9cd8"
}
,
"session_id"
:
"e9b7945dcbd5d18a6239acc7acafe8e9"
,
"type_of_user"
:
"impulso bu00e1sico"
,
"profile_id"
:
137
,
"code_profile"
:
"USUARIO"
,
"user_id"
:
50
,
"status"
:
null
,
"phone_lenght"
:
10
,
"menu"
:
[
[
"Acceso Ru00e1pido"
,
[
"Movements"
,
"movements"
,
false
]
,
[
"Add a card"
,
{' '}
"gestor_origenes_propios/crear"
,
false
]
,
[ {' '}
"Recharge cellphone minutes"
,
"Rechargecellphoneminutes"
,
false
]
,
[ {' '}
"Transfer between clients"
,
"moneysending"
,
false
]
,
[
"Request money"
,
"requestmoney"
,
false
]
,
[
"Services payment"
,
"payexpresspay"
,
false
]
]
]
,
"user_affiliate_id"
:
1
,
"currency"
:
"MXN"
,
"name"
:
"qwertyuio qwertyui"
,
"certificate"
:
false
,
"phone"
:
"9876543212"
}
```
Encrypted answer:
```javascript
{
"status"
:{' '}
true
,
"encrypted_data"
:{' '}
"k8DoQ9ADDph2o3oHdzeW0wO-FITgfGQD4xy9GcfuBtQy8IVazicD4J66kZ-HTlgWpCkXn7xlGDqCcXUNV
{' '}
TW9T7Ww1DpPXPyoilI2GPhOFliAWGpip_R56WVYr07qGmMUJy_n2I3si___hBb9MPEI3KBh9eupUO2gKDT
{' '}
bULimM_cpCtRHsqFdTZIpRedC0W_HdTgcCrZ_CItCoxAoyiCjx6knaH9dbaUV1GoywBWfuh3Dh4iqHGejH
{' '}
RbYi7Apm1PjCj5WNPEEN-UlfNj9hvurwTgCjBXilBg19ld3LUJj-1Yh48It_gLkna12ZqBiuUnQ3Rpj1hH
{' '}
vz7CkTjxStkigCyKA4lPh94cK_cJgaiv7c1Uyb54cB8N2bUTBhD4ojOSfR88bN-4wYiIEspinuKDmpHXO8
{' '}
HP_IgJSfgkU4QiTfbBKQ8u-2Hxe2x1JgbKIvjpiBNK0H3GNnaPrtciFf88EeQun5oZwOJiFtZBQHv-V4fd
{' '}
kfuOYBAWaOm13I9_PYiJir9BE145mIQOuugnebLASKju5UA-NHEclZ7fUF1fNyCeFxGW-6oYfadBanzpIM
{' '}
5PjRUODa92gF4X0pPcLy4v1jcegJSMSpTW0DH_vM14gV56OJ0Dvyf52OB2e3LDlfP7TwYmbY7YWwj5MpR1
{' '}
uoieOwbGsqbXqKvOOCmlwGIvAc-vowoTLRpviT1_fymNHyRqtb89Gjy_2rvsTgBLoZavKBOv5Wvu1Dil5u
{' '}
0wVzo7pqk5XV3lnTCi-t7kLiH7SfXtuIBhPQzPTO40btxpZwC2V4QBsx1BcBMs_cb7Kmcy53exgpQQQkRN
{' '}
bTU6jkSnTcccaCPzT9WGhxiHrS1U5bXXW4BM1j9aHFDjhBp6uT9_2QAh0oh-uljLTnw6r6KH69VFJyO2oK
{' '}
jG2Qttu-L95ynxW94ecMuLlU26O7F-j9IO1FpI-c8cfKAQs6tbUnv_cU49nTwpX5TZI1ZfCDOb042-KiCJ
{' '}
qOfP61FWZtEQrMw7VZwUxMylcku_In9caUUYgpvJhHwqE6GKdS0XuKEcGUV-tfMvBcnewCgobcZhIeTYKh
{' '}
KSoaA1AHR7IYHaf8U4isTCzcexJL_mnwHlvWGVEXmM2Ywy_y9Y6nIDFTXPsUG4aYjw="
}
```
Python code example to encrypt and decrypt (encryption key
highlighted)
```javascript
from Crypto
.Cipher{' '}
import AES
from Crypto
.Random{' '}
import new{' '}
as Random
from base64{' '}
import urlsafe_b64encode
, urlsafe_b64decode
class{' '}
CipherByAES
:
def{' '}
__init__
(self
)
:
self.block_size{' '}
={' '}
16
self.key{' '}
={' '}
'cedb3fb962255b1aafd033cabe831530'
self.pad{' '}
={' '}
lambda s
: s{' '}
+{' '}
(self
.block_size{' '}
-{' '}
len
(s
){' '}
% self
.block_size
){' '}
*
chr
(self
.block_size{' '}
-{' '}
len
(s
){' '}
% self
.block_size
)
self.unpad{' '}
={' '}
lambda s
: s
[
:
-
ord
(s
[
len
(s
){' '}
-{' '}
1
:
]
)
]
def{' '}
encrypt
(self
, data
)
:
plain_text = self
.pad
(data
)
iv = Random
(
)
.read
(AES
.block_size
)
cipher = AES
.new
(self
.key
, AES
.MODE_OFB
, iv
)
return urlsafe_b64encode
(iv{' '}
+ cipher
.encrypt
(plain_text
.encode
(
)
)
)
.decode
(
)
def{' '}
decrypt
(self
, data
)
:
cipher_text ={' '}
urlsafe_b64decode(data
.encode
(
)
)
iv = cipher_text
[
:self
.block_size
]
cipher = AES
.new
(self
.key
, AES
.MODE_OFB
, iv
)
return self
.unpad
(cipher
.decrypt
(cipher_text
[self
.block_size
]
)
)
.decode
(
)
```

17
docs/developer.avapframework.com/0_Communities_EN_Communities_EN.md Normal file
View File

@ -0,0 +1,17 @@
101OBeX organizes and groups the clients of a node or project into
communities.
Communities are groups of users or clients of a project whose main common
element or union is the community to which they belong. This is
determined, in most cases, although other criteria may apply, by
affiliates (corporations) responsible for registering users or
clients within the system.
Users or clients in a project that do not have a specific community will
belong to the community of the node or project. Importantly, end users or
customers retain the flexibility to switch between communities as needed.
Grouping users or customers by communities offers many advantages at the
operation and data analysis level, since it allows us to undertake actions
on a specific set of users or end customers based on the community to
which they belong. Moreover, it greatly enhances capabilities for data
mining and reporting activities.

0
docs/developer.avapframework.com/0_Comprar_Comprar_EN.md Normal file
View File

150
docs/developer.avapframework.com/0_Comprobar_el_importe_de_una_transaccion_EN_Comprobar_el_importe_de_una_transaccion_EN.md Normal file
View File

@ -0,0 +1,150 @@
This service returns the amount of a transaction to be able to see it.
GET:
`URL_BASE + /ws/util.py/get_importe_transaccion`
## Receives:
All parameters are sent in the querystring of the call, so a percentage
encoding for URI must be applied (aka URL encoding).
## Returns:
Depending on the result of the operation, this service can return two
different JSON:
### Answer JSON OK:
```javascript
{
"status"
:{' '}
true
,
"amount"
: <string>
,
"elapsed"
: <float>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `amount:` Amount of the transaction searched.
* `elapsed:` Operation execution time.
### Answer JSON KO:
```javascript
{
"status"
:{' '}
false
,
"level"
: <string>
,
"message"
: <string>
,
"error"
: <string>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `level:` Error importance level.
* `message:` Error message.
* `error:` Sole error code.
## Example requests:
### Python - Requests:
```javascript
import requests
url ={' '}
"URL_BASE/ws/util.py/get_importe_transaccion?country_code=MX&codtran=e34c6167505acbd1994a23082b3f1fc7"
payload ={' '}
{
}
files ={' '}
{
}
headers={' '}
{
}
response = requests
.request
(
"GET"
, url
, headers
=headers
, data{' '}
= payload
, files{' '}
= files
)
print
(response
.text
.encode
(
'utf8'
)
)
```
### NodeJs - Request:
```javascript
var request = require('request');
var options = {
'method': 'GET',
'url':
'URL_BASE/ws/util.py/get_importe_transaccion?country_code=MX&codtran=e34c6167505acbd1994a23082b3f1fc7',
'headers': {},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
### JavaScript - Fetch:
```javascript
var formdata = new FormData();
var requestOptions = {
method: 'GET',
body: formdata,
redirect: 'follow'
};
{' '}
fetch("URL_BASE/ws/util.py/get_importe_transaccion?country_code=MX&codtran=e34c6167505acbd1994a23082b3f1fc7",
requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
```
### CURL:
```javascript
curl --location --request GET{' '}
'URL_BASE/ws/util.py/get_importe_transaccion?country_code=MX&codtran=e34c6167505acbd1994a23082b3f1fc7'
```
## Business logic:
By means of this endpoint we obtain the amount associated with a
transaction.

0
docs/developer.avapframework.com/0_Confirmar_Ingreso_EN_Confirmar_Ingreso_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Consultar_Saldo_Monedero_Prepago_EN_Consultar_Saldo_Monedero_Prepago_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Crear_Programa_de_Puntos_EN_Crear_Programa_de_Puntos_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Cuadro_de_mando_EN_Cuadro_de_mando_EN.md Normal file
View File

34
docs/developer.avapframework.com/0_Currencies_FX_Exchange_EN_Currencies_FX_Exchange_EN.md Normal file
View File

@ -0,0 +1,34 @@
Within a node or project, two distinct modules exist, and understanding
their differences is crucial to prevent confusion. We are talking about
the Currencies and FX Exchange modules.
A node or project works with a location and a currency, information that
is provided at the time of creation of a node with the activation of a
project.
The currency selected when the node or project is created is the only
currency with which the node will operate until the administrator decides
to create or register new currencies.
That is, a node can be configured in a specific location, the United
States for example, and select USD as the currency for the node or
project. From that moment on, all operations carried out in that node or
project will be recorded with that currency. If later you want other
currencies to exist, such as EUR, you must register the request in the
node or project as an authorized currency.
This task is carried out in the Currencies section which can be found in
the node or project tab or in the side menu under the Projects section.
In this same section you can create your own currencies and assign them a
value with a purchase and sale price.
Working with a loyalty solution based on the accumulation of customer
points, based on their activity, requires registering those points as a
form of currency and giving them a value. In this way, the client will
always be able to use that points wallet in the operation network, thanks
to the FX Exchange service.
The mission of the FX Exchange service is to maintain a list of
currencies, the reference price, the purchase price, and the sale price,
thus allowing multi-currency operations.

0
docs/developer.avapframework.com/0_Dashboard_Afiliado_EN_Dashboard_Afiliado_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Datos_cuentas_EN_Datos_cuenta_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Desactivacion_de_una_cuenta_de_usuario_EN_Desactivacion_de_una_cuenta_de_usuario_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Desplegar_condiciones_legales_EN_Desplegar_condiciones_legales_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Devolucion_desde_afiliado_o_administrador_EN_Devolucion_desde_afiliado_o_administrador_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Editar_datos_usuario_EN_Editar_datos_usuario_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Entreorigenes_EN_Entreorigenes_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Enviar_donacion_a_un_usuario_EN_Enviar_donacion_a_un_usuario_EN.md Normal file
View File

0
docs/developer.avapframework.com/0_Historico_de_Confirmaciones_de_Ingresos_EN_Historico_de_Confirmaciones_de_Ingresos_EN.md Normal file
View File

26
docs/developer.avapframework.com/0_Introduction.md Normal file
View File

@ -0,0 +1,26 @@
This tool is designed to enable developers to work with the 101OBeX API.
With this tool, developers can retrieve information about their API
privileges, quotas, API Token, and more..
To begin, developers need to initialize their token using the
'init' parameter. This process involves authenticating through the
Google OAuth API to obtain the API token, which is stored locally on their
computer. Once the token is initialized, developers can use the
'info' parameter to access details about their API privileges,
projects, teams, and access token. Finally, developers have the option to
remove all downloaded information from their computer using the
'clean' parameter.
* https://github.com/101OBeXCorp/101obexcli/releases
Mac:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease-staging/101obexcli-macosx.zip
Linux:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli.-.linux.zip
Win32:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli-win32.zip

174
docs/developer.avapframework.com/0_close_close.md Normal file
View File

@ -0,0 +1,174 @@
## ws/orders.py/close
### Receives
All the parameters that the service receives must be indicated in the body
of the request.
## Returns:
Depending on the result of the operation, this service can return two
different JSON:
```javascript
{
"status"
:{' '}
true
,
"codtran"
:{' '}
"850c29598f8ceae89e7083d1547faa29"
,
"result"
:{' '}
"120d29398f8ceae89e707ad1547fa12c"
"elapsed"
:{' '}
0.12410902976989746
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `codtran:` Operation result.
* `result:` Code of the transaction that cancels the order.
* `elapsed:` Operation execution time.
### Answer JSON KO:
```javascript
{
"status"
:{' '}
false
,
"level"
: <string>
,
"message"
: <string>
,
"error"
: <string>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `level:` Error importance level.
* `message:` Error message.
* `error:` Sole error code.
## Example requests:
### Python - Requests:
```javascript
import requests
url ={' '}
"http://34.121.95.179:80/ws/orders.py/close?country_code=ES&user_id=133&session_id=1689-oocyMaFovWi1jljrF-eaSw=="
payload=
{
}
headers ={' '}
{
'101ObexApiKey'
:{' '}
'MS1phGJRa3WyLilN9dlZ7vurJDIpe0nM'
}
response = requests
.request
(
"GET"
, url
, headers
=headers
, data
=payload
)
print
(response
.text
)
```
### NodeJs - Request:
```javascript
var request = require('request');
var options = {
'method': 'GET',
'url':
'http://34.121.95.179:80/ws/orders.py/close?country_code=ES&user_id=133&session_id=1689-oocyMaFovWi1jljrF-eaSw==',
'headers': {
'101ObexApiKey': 'MS1phGJRa3WyLilN9dlZ7vurJDIpe0nM'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
### JavaScript - Fetch:
```javascript
var myHeaders = new Headers();
myHeaders.append("101ObexApiKey",
"MS1phGJRa3WyLilN9dlZ7vurJDIpe0nM");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("http://34.121.95.179:80/ws/orders.py/close?country_code=ES&user_id=133&session_id=1689-oocyMaFovWi1jljrF-eaSw==",
requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
```
### CURL:
```javascript
curl --location --request GET{' '}
'http://34.121.95.179:80/ws/orders.py/close?country_code=ES&user_id=133&session_id=1689-oocyMaFovWi1jljrF-eaSw=='
{' '}
\
--header{' '}
'101ObexApiKey: MS1phGJRa3WyLilN9dlZ7vurJDIpe0nM'
```
## Business logic:
The objective of this service is to permit an administrator close an
order.

26
docs/developer.avapframework.com/0_download_101cli_copy_3_download_101cli copy 3.md Normal file
View File

@ -0,0 +1,26 @@
This tool is designed to enable developers to work with the 101OBeX API.
With this tool, developers can retrieve information about their API
privileges, quotas, API Token, and more.
To begin, developers need to initialize their token using the
'init' parameter. This process involves authenticating through the
Google OAuth API to obtain the API token, which is stored locally on their
computer. Once the token is initialized, developers can use the
'info' parameter to access details about their API privileges,
projects, teams, and access token. Finally, developers have the option to
remove all downloaded information from their computer using the
'clean' parameter.
* https://github.com/101OBeXCorp/101obexcli/releases/tag/prerelease
Mac:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli-win32.zip
Linux:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli.-.linux.zip
Win32:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli.-.mac.zip

156
docs/developer.avapframework.com/10_get_signature_get_signature.md Normal file
View File

@ -0,0 +1,156 @@
This service is used to get the sign of a informed string
GET:
`URL_BASE + /ws/util.py/get_signature`
## Receives:
The string to be signed and the private key to sign the string
## Returns:
Depending on the result of the operation, this service can return two
different JSON:
### Answer JSON OK:
```javascript
{
"status": true, "signature":
"38779748c3bb130d0d1f8084ad92607d705e88b7", "elapsed":
0.002902984619140625
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `signature:` The signature calculated from the string{' '}
* `elapsed:` Operation execution time.
### Answer JSON KO:
```javascript
{
"status"
:{' '}
false
,
"nivel"
: <string>
,
"message"
: <string>
,
"error"
: <string>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `nivel:` Error importance level.
* `message:` Error message.
* `error:` Sole error code.
## Example requests:
### Python - Requests:
```javascript
import requests
url ={' '}
"http://api.staging.pademobile.com:8000/ws/util.py/get_signature?string_to_sign=codigo_pais%3DMX%26id_usuario%3D2%26telefono%3Doperabills%26importe%3D30000%26referencia%3DFondeo&private_key=3SQb94TOcHCm"
payload=
{
}
headers ={' '}
{
'101ObexApiKey'
:{' '}
'ri1JlbIJ7oO2kobKNwEdXrZDhd4PoZd8'
}
response = requests
.request
(
"GET"
, url
, headers
=headers
, data
=payload
)
print
(response
.text
)
```
### NodeJs - Request:
```javascript
var request = require('request');
var options = {
'method': 'GET',
'url':
'http://api.staging.pademobile.com:8000/ws/util.py/get_signature?string_to_sign=codigo_pais%3DMX%26id_usuario%3D2%26telefono%3Doperabills%26importe%3D30000%26referencia%3DFondeo&private_key=3SQb94TOcHCm',
'headers': {
'101ObexApiKey': 'ri1JlbIJ7oO2kobKNwEdXrZDhd4PoZd8'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
### JavaScript - Fetch:
```javascript
var myHeaders = new Headers();
myHeaders.append("101ObexApiKey",
"ri1JlbIJ7oO2kobKNwEdXrZDhd4PoZd8");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("http://api.staging.pademobile.com:8000/ws/util.py/get_signature?string_to_sign=codigo_pais%3DMX%26id_usuario%3D2%26telefono%3Doperabills%26importe%3D30000%26referencia%3DFondeo&private_key=3SQb94TOcHCm",
requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
```
### CURL:
```javascript
curl --location --request GET{' '}
'http://api.staging.pademobile.com:8000/ws/util.py/get_signature?string_to_sign=codigo_pais%3DMX%26id_usuario%3D2%26telefono%3Doperabills%26importe%3D30000%26referencia%3DFondeo&private_key=3SQb94TOcHCm'
{' '}
\
```
## Business logic:
With this endpoint it is allowed to calculate the sign from a strign using
a private key.

552
docs/developer.avapframework.com/11_GET_STARTED_KeyBindings_GET_STARTED_KeyBindings.md Normal file
View File

@ -0,0 +1,552 @@
AVAP TM Dev Studio 2024 lets you perform most tasks directly
from the keyboard. This page lists out the default bindings (keyboard
shortcuts) and describes how you can update them.
### Keyboard Shortcuts editor
AVAP TM Dev Studio provides a rich and easy keyboard shortcuts
editing experience using Keyboard Shortcuts editor. It
lists all available commands with and without keybindings and you can
easily change / remove / reset their keybindings using the available
actions. It also has a search box on the top that helps you in finding
commands or keybindings. You can open this editor by going to the menu
under File > Preferences >{' '}
Keyboard Shortcuts .
Most importantly, you can see keybindings according to your keyboard
layout. For example, key binding `Cmd+\` in US keyboard layout
will be shown as `Ctrl+Shift+Alt+Cmd+7` when layout is changed
to German. The dialog to enter key binding will assign the correct and
desired key binding as per your keyboard layout.
For doing more advanced keyboard shortcut customization, read Advanced
Customization.
### Keymap extensions
Keyboard shortcuts are vital to productivity and changing keyboarding
habits can be tough. To help with this, File >{' '}
Preferences >{' '}
Migrate Keyboard Shortcuts from... shows you a list of
popular keymap extensions. These extensions modify the AVAP TM {' '}
Dev Studio shortcuts to match those of other editors so you don't need
to learn new keyboard shortcuts. There is also a Keymaps category of
extensions in the Marketplace.
### Keyboard Shortcuts Reference
We also have a printable version of these keyboard shortcuts.{' '}
Help > Keyboard Shortcut Reference {' '}
displays a condensed PDF version suitable for printing as an easy
reference.
Below are links to the three platform-specific versions (US English
keyboard):
* Windows
* macOS
* Linux
### Detecting keybinding conflicts
If you have many extensions installed or you have customized your keyboard
shortcuts, you can sometimes have keybinding conflicts where the same
keyboard shortcut is mapped to several commands. This can result in
confusing behavior, especially if different keybindings are going in and
out of scope as you move around the editor.
The Keyboard Shortcuts editor has a context menu command{' '}
Show Same Keybindings , which will filter the keybindings
based on a keyboard shortcut to display conflicts.
Pick a command with the keybinding you think is overloaded and you can see
if multiple commands are defined, the source of the keybindings and when
they are active.
### Troubleshooting keybindings
To troubleshoot keybindings problems, you can execute the command{' '}
Developer: Toggle Keyboard Shortcuts Troubleshooting .
This will activate logging of dispatched keyboard shortcuts and will open
an output panel with the corresponding log file.
You can then press your desired keybinding and check what keyboard
shortcut AVAP™ DS detects and what command is invoked.
For example, when pressing `cmd+/` in a code editor on macOS,
the logging output would be:
```javascript
[KeybindingService]: / Received keydown event - modifiers: [meta], code:
MetaLeft, keyCode: 91, key: Meta
[KeybindingService]: | Converted keydown event - modifiers: [meta],
code: MetaLeft, keyCode: 57 ('Meta')
[KeybindingService]: \ Keyboard event cannot be dispatched.
[KeybindingService]: / Received keydown event - modifiers: [meta], code:
Slash, keyCode: 191, key: /
[KeybindingService]: | Converted keydown event - modifiers: [meta],
code: Slash, keyCode: 85 ('/')
[KeybindingService]: | Resolving meta+[Slash]
[KeybindingService]: \ From 2 keybinding entries, matched
editor.action.commentLine, when: editorTextFocus &&
!editorReadonly, source: built-in.
```
The first keydown event is for the MetaLeft key (cmd) and cannot
be dispatched. The second keydown event is for the Slash key (/)
and is dispatched as meta+[Slash]. There were two keybinding entries
mapped from meta+[Slash] and the one that matched was for the command
editor.action.commentLine, which has the when condition editorTextFocus
&& !editorReadonly and is a built-in keybinding entry.
### Viewing modified keybindings
You can view any user modified keyboard shortcuts in AVAP TM Dev
Studio in the Keyboard Shortcuts editor with the Show
User Keybindings command in the More Actions (...) menu. This
applies the @source:user filter to the Keyboard Shortcuts editor
(Source is 'User').
### Advanced customization
All keyboard shortcuts in AVAP TM Dev Studio can be customized
via the keybindings.json file.
To configure keyboard shortcuts through the JSON file, open{' '}
Keyboard Shortcuts editor and select the{' '}
Open Keyboard Shortcuts (JSON) button on the
right of the editor title bar. This will open your keybindings.json file
where you can overwrite the Default Keyboard Shortcuts.
You can also open the keybindings.json file from the Command Palette
(Ctrl+Shift+P) with the Preferences: Open Keyboard Shortcuts
(JSON) command.
### Keyboard rules
Each rule consists of:
* a key that describes the pressed keys.
* a command containing the identifier of the command to execute.
* an optional when clause containing a boolean expression that will be evaluated depending on the current context.
Chords (two separate keypress actions) are described by separating
the two keypresses with a space. For example, `Ctrl+K Ctrl+C` .
When a key is pressed:
* the rules are evaluated from bottom to{' '} top .
* the first rule that matches, both the key and in terms of when, is accepted.
* no more rules are processed.
* if a rule is found and has a command set, the command is executed.
The additional keybindings.json rules are appended at runtime to the
bottom of the default rules, thus allowing them to overwrite the default
rules. The keybindings.json file is watched by AVAP™ DS so editing it
while AVAP TM Dev Studio is running will update the rules at
runtime.
The keyboard shortcuts dispatching is done by analyzing a list of rules
that are expressed in JSON. Here are some examples:
```javascript
// Keybindings that are active when the focus is in the editor
{ "key": "home", "command": "cursorHome", "when": "editorTextFocus"
},
{ "key": "shift+home", "command": "cursorHomeSelect", "when":
"editorTextFocus" },
// Keybindings that are complementary
{ "key": "f5", "command": "workbench.action.debug.continue",
"when": "inDebugMode" },
{ "key": "f5", "command": "workbench.action.debug.start", "when":
"!inDebugMode" },
// Global keybindings
{ "key": "ctrl+f", "command": "actions.find" },
{ "key": "alt+left", "command": "workbench.action.navigateBack"
},
{ "key": "alt+right", "command": "workbench.action.navigateForward"
},
// Global keybindings using chords (two separate keypress
actions)
{ "key": "ctrl+k enter", "command": "workbench.action.keepEditor"
},
{ "key": "ctrl+k ctrl+w", "command":
"workbench.action.closeAllEditors" },
```
### Accepted keys
The key is made up of modifiers and the key itself.
The following modifiers are accepted:
The following keys are accepted:
* `f1-f19` , `a-z` , `0-9`
* ```, `-` , `=` , `[` , `]` ,{' '} `\` , `;` , `'` , `,` ,{' '} `.` , `/`
* `left` , `up` , `right` ,{' '} `down` , `pageup` , `pagedown` ,{' '} `end` , `home`
* `tab` , `enter` , `escape` ,{' '} `space` , `backspace` , `delete`
* `pausebreak` , `capslock` , `insert`
* `numpad0-numpad9` , `numpad_multiply` ,{' '} `numpad_add` , `numpad_separator`
* `numpad_subtract` , `numpad_decimal` ,{' '} `numpad_divide`
### Command arguments
You can invoke a command with arguments. This is useful if you often
perform the same operation on a specific file or folder. You can add a
custom keyboard shortcut to do exactly what you want.
The following is an example overriding the `Enter` key to print
some text:
```javascript
{
"key": "enter",
"command": "type",
"args": { "text": "Hello World" },
"when": "editorTextFocus"
}
```
The type command will receive {"text": "Hello
World"} as its first argument and add "Hello World" to
the file instead of producing the default command.
For more information on commands that take arguments, refer to Built-in
Commands.
### Running multiple commands
It is possible to create a keybinding that runs several other commands
sequentially using the command runCommands.
Run several commands without arguments: copy current line down, mark the
current line as comment, move cursor to copied line
```javascript
{
"key": "ctrl+alt+c",
"command": "runCommands",
"args": {
"commands": [ "editor.action.copyLinesDownAction",
"cursorUp",
"editor.action.addCommentLine",
"cursorDown"
] }
},
```
It is also possible to pass arguments to commands: create a new untitled
TypeScript file and insert a custom snippet
```javascript
{
"key": "ctrl+n",
"command": "runCommands",
"args": {
"commands": [ {
"command": "workbench.action.files.newUntitledFile",
"args": {
"languageId": "typescript"
}
},
{
"command": "editor.action.insertSnippet",
"args": {
"langId": "typescript",
"snippet": "class ${1:ClassName}
{\n\tconstructor() {\n\t\t$0\n\t}\n}"
}
}
] }
},
```
Note that commands run by runCommands receive the value of
"args" as the first argument. So in the example above,
workbench.action.files.newUntitledFile receives
{"languageId": "typescript" } as its first
and only argument.
To pass several arguments, one needs to have "args" as an array:
```javascript
{
"key": "ctrl+shift+e",
"command": "runCommands",
"args": {
"commands": [ {
// command invoked with 2 arguments:
vscode.executeCommand("myCommand", "arg1", "arg2")
"command": "myCommand",
"args": ["arg1", "arg2"]
}
] }
}
```
To pass an array as the first argument, one needs to wrap the array in
another array: "args": [ [1, 2, 3] ].
### Removing a specific key binding rule
You can write a key binding rule that targets the removal of a specific
default key binding. With the keybindings.json, it was always possible to
redefine all the key bindings of AVAP TM Dev Studio, but it can
be difficult to make a small tweak, especially around overloaded keys,
such as `Tab` or `Escape` . To remove a specific key
binding, add a - to the command and the rule will be a removal rule.
Here is an example:
```javascript
// In Default Keyboard Shortcuts
...
{ "key": "tab", "command": "tab", "when": ... },
{ "key": "tab", "command": "jumpToNextSnippetPlaceholder", "when":
... },
{ "key": "tab", "command": "acceptSelectedSuggestion", "when": ...
},
...
// To remove the second rule, for example, add in keybindings.json:
{ "key": "tab", "command": "-jumpToNextSnippetPlaceholder" }
```
To override a specific key binding rule with an empty action, you can
specify an empty command:
```javascript
// To override and disable any `tab` keybinding, for example, add in
keybindings.json:
{ "key": "tab", "command": "" }
```
### Keyboard layouts
The keys above are string representations for virtual keys and do not
necessarily relate to the produced character when they are pressed. More
precisely:
* Reference: Virtual-Key Codes (Windows)
* `tab` for VK_TAB (0x09)
* ; for VK_OEM_1 (0xBA)
* `=` for VK_OEM_PLUS (0xBB)
* `,` for VK_OEM_COMMA (0xBC)
* `-` for VK_OEM_MINUS (0xBD)
* `.` for VK_OEM_PERIOD (0xBE)
* `/` for VK_OEM_2 (0xBF)
* ` for VK_OEM_3 (0xC0)
* `[` for VK_OEM_4 (0xDB)
* `\` for VK_OEM_5 (0xDC)
* `]` for VK_OEM_6 (0xDD)
* `'` for VK_OEM_7 (0xDE)
* etc.
Different keyboard layouts usually reposition the above virtual keys or
change the characters produced when they are pressed. When using a
different keyboard layout than the standard US, AVAP TM Dev
Studio does the following:
All the key bindings are rendered in the UI using the current system's
keyboard layout. For example, Split Editor when using a French
(France) keyboard layout is now rendered as `Ctrl+*` :
When editing keybindings.json, AVAP TM Dev Studio highlights
misleading key bindings, those that are represented in the file with the
character produced under the standard US keyboard layout, but that need
pressing keys with different labels under the current system's
keyboard layout. For example, here is how the{' '}
Default Keyboard Shortcuts rules look like when using a
French (France) keyboard layout:
There is also a widget that helps input the key binding rule when editing
keybindings.json. To launch the Define Keybinding widget, press{' '}
`Ctrl+K Ctrl+K` . The widget listens for key presses and renders
the serialized JSON representation in the text box and below it, the keys
that AVAP TM Dev Studio has detected under your current keyboard
layout. Once you've typed the key combination you want, you can press{' '}
`Enter` and a rule snippet will be inserted.
### Keyboard layout-independent bindings
Using scan codes, it is possible to define keybindings which do not change
with the change of the keyboard layout. For example:
```javascript
{ "key": "cmd+[Slash]", "command": "editor.action.commentLine",
"when": "editorTextFocus" }
```
Accepted scan codes:
* `[F1]-[F19]` , `[KeyA]-[KeyZ]` ,{' '} `[Digit0]-[Digit9]`
* `[Backquote]` , `[Minus]` , `[Equal]` ,{' '} `[BracketLeft]` , `[BracketRight]` ,{' '} `[Backslash]` , `[Semicolon]` ,{' '} `[Quote]` , `[Comma]` , `[Period]` ,{' '} `[Slash]`
* `[ArrowLeft]` , `[ArrowUp]` ,{' '} `[ArrowRight]` , `[ArrowDown]` ,{' '} `[PageUp]` , `[PageDown]` , `[End]` ,{' '} `[Home]`
* `[Tab]` , `[Enter]` , `[Escape]` ,{' '} `[Space]` , `[Backspace]` , `[Delete]`
* `[Pause]` , `[CapsLock]` , `[Insert]`
* `[Numpad0]-[Numpad9]` , `[NumpadMultiply]` ,{' '} `[NumpadAdd]` , `[NumpadComma]`
* `[NumpadSubtract]` , `[NumpadDecimal]` ,{' '} `[NumpadDivide]`
### when clause contexts
AVAP TM Dev Studio gives you fine control over when your key
bindings are enabled through the optional when clause. If your key binding
doesn't have a when clause, the key binding is globally available at
all times. A when clause evaluates to either Boolean true or false for
enabling key bindings.
AVAP TM Dev Studio sets various context keys and specific values
depending on what elements are visible and active in the AVAP TM {' '}
Dev Studio UI. For example, the built-in Start Debugging command has the
keyboard shortcut `F5` , which is only enabled when there is an
appropriate debugger available (context debuggersAvailable is
true) and the editor isn't in debug mode (context inDebugMode
is false):
You can also view a keybinding's when clause directly in the Default
Keybindings JSON (
Preferences: Open Default Keyboard Shortcuts (JSON)
):
```javascript
{ "key": "f5", "command": "workbench.action.debug.start",
"when": "debuggersAvailable && !inDebugMode" },
```
For when clause conditional expressions, the following conditional
operators are useful for keybindings:
You can find the full list of when clause conditional operators in the
when clause contexts reference.
You can find some of the available when clause contexts in the when clause
context reference.
The list there isn't exhaustive and you can find other when clause
contexts by searching and filtering in the Keyboard Shortcuts editor (
Preferences: Open Keyboard Shortcuts ) or reviewing
the Default Keybindings JSON file (
Preferences: Open Default Keyboard Shortcuts (JSON)
).
### Custom keybindings for refactorings
The editor.action.codeAction command lets you configure keybindings for
specific Refactorings (Code Actions). For example, the keybinding
below triggers the Extract function refactoring Code
Actions:
```javascript
{
"key": "ctrl+shift+r ctrl+e",
"command": "editor.action.codeAction",
"args": {
"kind": "refactor.extract.function"
}
}
```
This is covered in depth in the Refactoring topic where you can learn
about different kinds of Code Actions and how to prioritize them in the
case of multiple possible refactorings.
### Default Keyboard Shortcuts
You can view all default keyboard shortcuts in AVAP Dev Studio in the{' '}
Keyboard Shortcuts editor with the{' '}
Show Default Keybindings command in the{' '}
More Actions (...) menu. This applies the
@source:default filter to the Keyboard Shortcuts editor
( Source is 'Default').
You can view the default keyboard shortcuts as a JSON file using the
command{' '}
Preferences: Open Default Keyboard Shortcuts (JSON)
.
Some commands included below do not have default keyboard shortcuts and so
are displayed as unassigned but you can assign your own keybindings.
### Next steps
Now that you know about our Key binding support, what's next...
* Language Support - Our Good, Better, Best language grid to see what you can expect
* Debugging - This is where AVAP™ DS really shines
* Node.js - End to end Node.js scenario with a sample app
### Common questions
In the Keyboard Shortcut editor, you can filter on
specific keystrokes to see which commands are bound to which keys. Below
you can see that Ctrl+Shift+P is bound to{' '}
Show All Commands to bring up the Command Palette.
Find a rule that triggers the action in the{' '}
Default Keyboard Shortcuts and write a modified version
of it in your keybindings.json file:
```javascript
// Original, in Default Keyboard Shortcuts
{ "key": "ctrl+shift+k", "command": "editor.action.deleteLines",
"when": "editorTextFocus" },
// Modified, in User/keybindings.json, Ctrl+D now will also trigger this
action
{ "key": "ctrl+d", "command": "editor.action.deleteLines",
"when": "editorTextFocus" },
```
Use the editorLangId context key in your when clause:
```javascript
{ "key": "shift+alt+a", "command": "editor.action.blockComment",
"when": "editorTextFocus && editorLangId == csharp"
},
```
The most common problem is a syntax error in the file. Otherwise, try
removing the when clause or picking a different key. Unfortunately, at
this point, it is a trial and error process.

933
docs/developer.avapframework.com/12_GET_STARTED_Tips_and_tricks_GET_STARTED_Tips_and_tricks.md Normal file
View File

@ -0,0 +1,933 @@
"Tips and Tricks" lets you jump right in and learn how to be
productive with AVAP™ Dev Studio 2024. You'll become familiar with its
powerful editing, code intelligence, and source code control features and
learn useful keyboard shortcuts. This topic goes pretty fast and provides
a broad overview, so be sure to look at the other in-depth topics in
Getting Started and the User Guide to learn more.
### Basics
The best way of exploring AVAP TM Dev Studio hands-on is to open
the Welcome page. You will get an overview of AVAP TM Dev
Studio's customizations and features. Help > Welcome.
Pick a Walkthrough for a self-guided tour through the
setup steps, features, and deeper customizations that AVAP TM {' '}
Dev Studio offers. As you discover and learn, the walkthroughs track your
progress.
If you are looking to improve your code editing skills open the{' '}
Interactive Editor Playground . Try out AVAP TM {' '}
Dev Studio's code editing features, like multi-cursor editing,
IntelliSense, Snippets, Emmet, and many more.{' '}
Help > Editor Playground .
Access all available commands based on your current context.
Keyboard Shortcut: Ctrl+Shift+P
All of the commands are in the Command Palette with the associated key
binding (if it exists). If you forget a keyboard shortcut, use the
Command Palette to help you out.
Download the keyboard shortcut reference sheet for your platform
(macOS, Windows, Linux).
Quickly open files.
Keyboard Shortcut: `Ctrl+P`
Tip : Type `?` to view command suggestions.
Typing commands such as edt and term followed by a space will bring up
dropdown lists.
Repeat the Quick Open keyboard shortcut to cycle quickly
between recently opened files.
You can open multiple files from Quick Open by pressing
the Right arrow key. This will open the currently selected file in the
background and you can continue selecting files from{' '}
Quick Open .
Open Recent
Keyboard Shortcut: `Ctrl+R`
Displays a Quick Pick dropdown with the list from File {' '}
> Open Recent with recently opened folders and
workspaces followed by files.
### Command line
AVAP TM Dev Studio has a powerful command line interface
(CLI) which allows you to customize how the editor is launched to
support various scenarios.
```javascript
# open code with current directory
code .
# open the current directory in the most recently used code window
code -r .
# create a new window
code -n
# change the language
code --locale=es
# open diff editor
code --diff <file1> <file2>
# open file at specific line and column <file:line[:character]>
code --goto package.json:10:5
# see help options
code --help
# disable all extensions
code --disable-extensions .
```
Workspace specific files are in a .avapcode folder at the root. For
example, tasks.json for the Task Runner and launch.json for the debugger.{' '}
### Status Bar
Keyboard Shortcut: `Ctrl+Shift+M`
Quickly jump to errors and warnings in the project.
Cycle through errors with `F8` or `Shift+F8`
You can filter problems either by type ('errors',
'warnings') or text matching.
Keyboard Shortcut: `Ctrl+K M`
If you want to persist the new language mode for that file type, you can
use the Configure File Association for command to
associate the current file extension with an installed language.
### Customization
There are many things you can do to customize AVAP TM Dev .
* Change your theme
* Change your keyboard shortcuts
* Tune your settings
* Add JSON validation
* Create snippets
* Install extensions
Keyboard Shortcut: `Ctrl+K Ctrl+T`
You can install more themes from the AVAP TM Dev Studio
extension Marketplace.
Are you used to keyboard shortcuts from another editor? You can install a
Keymap extension that brings the keyboard shortcuts from your favorite
editor to AVAP TM Dev Studio. Go to Preferences {' '}
> Migrate Keyboard Shortcuts from ... to see the
current list on the Marketplace. Some of the more popular ones:
* Vim
* Sublime Text Keymap
* Emacs Keymap
* Atom Keymap
* Brackets Keymap
* Eclipse Keymap
* AVAP™ Dev Studio Keymap
Keyboard Shortcut: `Ctrl+K Ctrl+S`
You can search for shortcuts and add your own keybindings to the
keybindings.json file.
See more in Key Bindings for AVAP TM Dev Studio.
By default AVAP TM Dev Studio shows the Settings editor, you can
find settings listed below in a search bar, but you can still edit the
underlying settings.json file by using the{' '}
Open User Settings (JSON) command or by changing
your default settings editor with the workbench.settings.editor setting.
Open User Settings settings.json
Keyboard Shortcut: `Ctrl+,`
Change the font size of various UI elements
```javascript
// Main editor
"editor.fontSize": 18,
// Terminal panel
"terminal.integrated.fontSize": 14,
// Output panel
"[Log]": {
"editor.fontSize": 15
}
```
Change the zoom level
```javascript
"window.zoomLevel": 5
```
Font ligatures
```javascript
"editor.fontFamily": "Fira Code",
"editor.fontLigatures": true
```
Auto Save
```javascript
"files.autoSave": "afterDelay"
```
You can also toggle Auto Save from the top-level menu with the File >
Auto Save.
Format on save
```javascript
"editor.formatOnSave": true
```
Format on paste
```javascript
"editor.formatOnPaste": true
```
Change the size of Tab characters
```javascript
"editor.tabSize": 4
```
Spaces or Tabs
```javascript
"editor.insertSpaces": true
```
Render whitespace
```javascript
"editor.renderWhitespace": "all"
```
Whitespace characters are rendered by default in text selection.
Ignore files / folders
Removes these files / folders from your editor window.
```javascript
"files.exclude": {
"somefolder/": true,
"somefile": true
}
```
Remove these files / folders from search results.
```javascript
"search.exclude": {
"someFolder/": true,
"somefile": true
}
```
And many, many other customizations.
You can scope the settings that you only want for specific languages by
the language identifier. You can find a list of commonly used language IDs
in the Language Identifiers reference.
```javascript
"[languageid]": {
}
```
Enabled by default for many file types. Create your own schema and
validation in settings.json
```javascript
"json.schemas": [ {
"fileMatch": [ "/bower.json"
],
"url": "https://json.schemastore.org/bower"
}
]
```
or for a schema defined in your workspace
```javascript
"json.schemas": [ {
"fileMatch": [ "/foo.json"
],
"url": "./myschema.json"
}
]
```
or a custom schema
```javascript
"json.schemas": [ {
"fileMatch": [ "/.myconfig"
],
"schema": {
"type": "object",
"properties": {
"name" : {
"type": "string",
"description": "The name of the entry"
}
}
}
}
]
```
See more in the JSON documentation.
### Extensions
Keyboard Shortcut: `Ctrl+Shift+X`
In the Extensions view, you can search via the search bar
or click the More Actions (...) button to filter
and sort by install count.
In the Extensions view, click{' '}
Show Recommended Extensions in the{' '}
More Actions (...) button menu.
Are you interested in creating your own extension? You can learn how to do
this in the Extension API documentation, specifically check out the
documentation on contribution points.
* configuration
* commands
* keybindings
* languages
* debuggers
* grammars
* themes
* snippets
* jsonValidation
### Files and folders
Keyboard Shortcut: Ctrl+`
Further reading:
* Integrated Terminal documentation
* Mastering AVAP™ DS's Terminal article
Keyboard Shortcut: `Ctrl+B`
Keyboard Shortcut: `Ctrl+J`
Keyboard Shortcut: `Ctrl+K Z`
Enter distraction free Zen mode.
Press `Esc` twice to exit Zen Mode.
Keyboard Shortcut: `Ctrl+\`
You can also drag and drop editors to create new editor groups and move
editors between groups.
Keyboard Shortcut: `Ctrl+1` , `Ctrl+2` ,{' '}
`Ctrl+3`
Keyboard Shortcut: `Ctrl+Shift+E`
Keyboard Shortcut: `Ctrl+click` ( `Cmd+click` on
macOS)
You can quickly open a file or image or create a new file by moving the
cursor to the file link and using `Ctrl+click` .
Keyboard Shortcut: `Ctrl+K F`
Navigate entire history: `Ctrl+Tab`
Navigate back: `Alt+Left`
Navigate forward: `Alt+Right`
Create language associations for files that aren't detected correctly.
For example, many configuration files with custom file extensions are
actually JSON.
```javascript
"files.associations": {
".database": "json"
}
```
AVAP TM Dev Studio will show you an error message when you try
to save a file that cannot be saved because it has changed on disk. AVAP
TM Dev Studio blocks saving the file to prevent overwriting
changes that have been made outside of the editor.
In order to resolve the save conflict, click the Compare action in the
error message to open a diff editor that will show you the contents of the
file on disk (to the left) compared to the contents in AVAP
TM Dev Studio (on the right):
Use the actions in the editor toolbar to resolve the save conflict. You
can either Accept your changes and thereby overwriting
any changes on disk, or Revert to the version on disk.
Reverting means that your changes will be lost.
Note : The file will remain dirty and cannot be saved
until you pick one of the two actions to resolve the conflict.
### Editing Hacks
Here is a selection of common features for editing code. If the keyboard
shortcuts aren't comfortable for you, consider installing a keymap
extension for your old editor.
Tip : You can see recommended keymap extensions in the{' '}
Extensions view by filtering the search to
@recommended:keymaps.
To add cursors at arbitrary positions, select a position with your mouse
and use `Alt+Click` ( `Option+Click` on
macOS).
To set cursors above or below the current position use:
Keyboard Shortcut: `Ctrl+Alt+Up` or `Ctrl+Alt+Down`
You can add additional cursors to all occurrences of the current selection
with Ctrl+Shift+L.
If you do not want to add all occurrences of the current selection, you
can use Ctrl+D instead. This only selects the next occurrence after the
one you selected so you can add selections one by one.
You can select blocks of text by holding `Shift+Alt` (
`Shift+Option` on macOS) while you drag your mouse. A
separate cursor will be added to the end of each selected line.
You can also use keyboard shortcuts to trigger column selection.
You can add vertical column rulers to the editor with the editor.rulers
setting, which takes an array of column character positions where
you'd like vertical rulers.
```javascript
{
"editor.rulers": [20, 40, 60]
}
```
Pressing the Alt key enables fast scrolling in the editor and Explorers.
By default, fast scrolling uses a 5X speed multiplier but you can control
the multiplier with the * Editor: Fast Scroll Sensitivity *
(editor.fastScrollSensitivity) setting.
Keyboard Shortcut: `Shift+Alt+Up` or{' '}
`Shift+Alt+Down`
Keyboard Shortcut: `Alt+Up` or `Alt+Down`
Keyboard Shortcut: `Shift+Alt+Left` or{' '}
`Shift+Alt+Right`
You can learn more in the Basic Editing documentation.
Keyboard Shortcut: `Ctrl+Shift+O`
You can group the symbols by kind by adding a colon, @:.
Keyboard Shortcut: `Ctrl+T`
The Outline view in the File Explorer (default collapsed at the
bottom) shows you the symbols of the currently open file.
You can sort by symbol name, category, and position in the file and allows
quick navigation to symbol locations.
Keyboard Shortcut: `Ctrl+G`
Keyboard Shortcut: `Ctrl+U`
Keyboard Shortcut: `Ctrl+K Ctrl+X`
Currently selected source code: `Ctrl+K Ctrl+F`
Whole document format: `Shift+Alt+F`
Keyboard Shortcut: `Ctrl+Shift+[` and `Ctrl+Shift+]`
You can also fold/unfold all regions in the editor with Fold All (
`Ctrl+K Ctrl+0` ) and Unfold All (
`Ctrl+K Ctrl+J` ).
You can fold all block comments with Fold All Block Comments (
`Ctrl+K Ctrl+/` ).
Keyboard Shortcut: `Ctrl+L`
Keyboard Shortcut: `Ctrl+Home` and `Ctrl+End`
In a Markdown file, use
Keyboard Shortcut: `Ctrl+Shift+V`
In a Markdown file, use
Keyboard Shortcut: `Ctrl+K V`
The preview and editor will synchronize with your scrolling in either
view.
### IntelliSense
`Ctrl+Space` to trigger the Suggestions widget.
You can view available methods, parameter hints, short documentation, etc.
Select a symbol then type `Alt+F12` . Alternatively, you can use
the context menu.
Select a symbol then type `F12` . Alternatively, you can use the
context menu or `Ctrl+click` ( `Cmd+click` on
macOS).
You can go back to your previous location with the Go {' '}
> Back command or `Alt+Left` .
You can also see the type definition if you press `Ctrl` (
`Cmd` on macOS) when you are hovering over the type.
Select a symbol then type `Shift+F12` . Alternatively, you can
use the context menu.
Select a symbol then type `Shift+Alt+F12` to open the
References view showing all your file's symbols in a dedicated view.
Select a symbol then type `F2` . Alternatively, you can use the
context menu.
rename symbol
Besides searching and replacing expressions, you can also search and reuse
parts of what was matched, using regular expressions with capturing
groups. Enable regular expressions in the search box by clicking the{' '}
Use Regular Expression .* button ( `Alt+R`
) and then write a regular expression and use parentheses to define
groups. You can then reuse the content matched in each group by using $1,
$2, etc. in the Replace field.
Install the ESLint extension. Configure your linter however you'd
like. Consult the ESLint specification for details on its linting rules
and options.
Here is configuration to use ES6.
```javascript
{
"env": {
"browser": true,
"commonjs": true,
"es6": true,
"node": true
},
"parserOptions": {
"ecmaVersion": 6,
"sourceType": "module",
"ecmaFeatures": {
"jsx": true,
"classes": true,
"defaultParams": true
}
},
"rules": {
"no-const-assign": 1,
"no-extra-semi": 0,
"semi": 0,
"no-fallthrough": 0,
"no-empty": 0,
"no-mixed-spaces-and-tabs": 0,
"no-redeclare": 0,
"no-this-before-super": 1,
"no-undef": 1,
"no-unreachable": 1,
"no-use-before-define": 0,
"constructor-super": 1,
"curly": 0,
"eqeqeq": 0,
"func-names": 0,
"valid-typeof": 1 }
}
```
See IntelliSense for your package.json file.
Support for Emmet syntax.
### Snippets
File > Preferences >{' '}
Configure User Snippets , select the language, and create
a snippet.
```javascript
"create component": {
"prefix": "component",
"body": [ "class $1 extends React.Component {",
"",
"\trender() {",
"\t\treturn ($2);",
"\t}",
"",
"}"
]
},
```
See more details in Creating your own Snippets.
### Git integration
Keyboard Shortcut: `Ctrl+Shift+G`
Git integration comes with AVAP TM Dev Studio
"out-of-the-box". You can install other SCM providers from the
Extension Marketplace. This section describes the Git integration but much
of the UI and gestures are shared by other SCM providers.
From the Source Control view, select a file to open the diff.
Alternatively, click the Open Changes button in the top
right corner to diff the current open file.
Views
The default view for diffs is the side by side view .
Toggle inline view by clicking the{' '}
More Actions (...) button in the top right and
selecting Toggle Inline View .
If you prefer the inline view, you can set
"diffEditor.renderSideBySide": false.
Accessible Diff Viewer
Navigate through diffs with `F7` and `Shift+F7` .
This will present them in a unified patch format. Lines can be navigated
with arrow keys and pressing `Enter` will jump back in the diff
editor and the selected line.
Edit pending changes
You can make edits directly in the pending changes of the diff view.
Easily switch between Git branches via the Status Bar.
Stage file changes
Hover over the number of files and click the plus button.
Click the minus button to unstage changes.
Stage selected
Stage a portion of a file by selecting that file (using the
arrows) and then choosing Stage Selected Ranges from
the Command Palette .
Click the (...) button and then select{' '}
Undo Last Commit to undo the previous commit. The changes
are added to the Staged Changes section.
AVAP TM Dev Studio makes it easy to see what Git commands are
actually running. This is helpful when learning Git or debugging a
difficult source control issue.
Use the Toggle Output command (
`Ctrl+Shift+U` ) and select Git in the
dropdown.
View diff decorations in editor. See documentation for more details.
During a merge, go to the Source Control view (
`Ctrl+Shift+G` ) and make changes in the diff view.
You can resolve merge conflicts with the inline CodeLens which lets you{' '}
Accept Current Change ,{' '}
Accept Incoming Change ,{' '}
Accept Both Changes , and Compare Changes
.
```javascript
git config --global merge.tool vscode
git config --global mergetool.vscode.cmd 'code --wait $MERGED'
```
```javascript
git config --global diff.tool vscode
git config --global difftool.vscode.cmd 'code --wait --diff $LOCAL
$REMOTE'
```
### Debugging
From the Run and Debug view ( `Ctrl+Shift+D` ), select{' '}
create a launch.json file , which will prompt you to
select the environment that matches your project (Node.js, Python,
C++, etc). This will generate a launch.json file. Node.js support is
built-in and other environments require installing the appropriate
language extensions. See the debugging documentation for more details.
Place breakpoints next to the line number. Navigate forward with the Debug
widget.
Place breakpoints next to the line number. Navigate forward with the Debug
widget.
Inspect variables in the Run panels and in the console.
Logpoints act much like breakpoints but instead of halting the debugger
when they are hit, they log a message to the console. Logpoints are
especially useful for injecting logging while debugging production servers
that cannot be modified or paused.
Add a logpoint with the Add Logpoint command in the left
editor gutter and it will be displayed as a "diamond" shaped
icon. Log messages are plain text but can include expressions to be
evaluated within curly braces ('{}').
A trigged breakpoint is a breakpoint that is automatically enabled once
another breakpoint is hit. They can be very useful when diagnosing failure
cases in code that happen only after a certain precondition.
Triggered breakpoints can be set by right-clicking on the glyph margin,
selecting Add Triggered Breakpoint , and then choosing
which other breakpoint enables the breakpoint.
http://https://code.visualstudio.com/assets/docs/editor/debugging/debug-triggered-breakpoint.mp4
### Task runner
Select Terminal from the top-level menu, run the command{' '}
Configure Tasks , then select the type of task you'd
like to run. This will generate a tasks.json file with content like the
following. See the Tasks documentation for more details.
```javascript
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [ {
"type": "npm",
"script": "install",
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
```
There are occasionally issues with auto generation. Check out the
documentation for getting things to work properly.
Select Terminal from the top-level menu, run the command{' '}
Run Task , and select the task you want to run. Terminate
the running task by running the command Terminate Task
You can define a keyboard shortcut for any task. From the{' '}
Command Palette ( `Ctrl+Shift+P` ),
select Preferences: Open Keyboard Shortcuts File , bind
the desired shortcut to the workbench.action.tasks.runTask command, and
define the Task as args.
For example, to bind `Ctrl+H` to the Run tests task, add the
following:
```javascript
{
"key": "ctrl+h",
"command": "workbench.action.tasks.runTask",
"args": "Run tests"
}
Run npm s
```
From the explorer you can open a script in the editor, run it as a task,
and launch it with the node debugger (when the script defines a debug
option like --inspect-brk). The default action on click is to open the
script. To run a script on a single click, set npm.scriptExplorerAction to
"run". Use the setting npm.exclude to exclude scripts in
package.json files contained in particular folders.
With the setting npm.enableRunFromFolder, you can enable to run npm
scripts from the File Explorer's context menu for a folder. The
setting enables the command Run NPM Script in Folder ...
when a folder is selected. The command shows a Quick Pick list of the npm
scripts contained in this folder and you can select the script to be
executed as a task.
### Portable mode
AVAP TM Dev Studio has a Portable mode which lets you keep
settings and data in the same location as your installation, for example,
on a USB drive.
### Insiders builds
The AVAP™ Dev Studio Code team uses the Insiders version to test the
latest features and bug fixes of AVAP™ DS. You can also use the Insiders
version by downloading it here.
* For Early Adopters - Insiders has the most recent code changes for users and extension authors to try out.
* Frequent Builds - New builds every day with the latest bug fixes and features.
* Side-by-side install - Insiders installs next to the Stable build allowing you to use either independently.

0
docs/developer.avapframework.com/13_get_token_info_get_token_info.md Normal file
View File

0
docs/developer.avapframework.com/15_get_vaulted_transactions_get_vaulted_transactions.md Normal file
View File

0
docs/developer.avapframework.com/17_getUSDGRAYcotization_getUSDGRAYcotization.md Normal file
View File

0
docs/developer.avapframework.com/1_Administrar_solicitudes_KYC_GET_EN_Administrar_solicitudes_KYC_GET_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Agregar_usuarios_a_la_lista_negra_EN_Agregar_usuarios_a_la_lista_negra_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Autorizar_carga_masiva_de_saldo_EN_Autorizar_carga_masiva_de_saldo_EN.md Normal file
View File

78
docs/developer.avapframework.com/1_Billing_System.md Normal file
View File

@ -0,0 +1,78 @@
101OBeX offers different plans:
* Developer
* Startup
* Business
* Enterprise
The ideal plan to become familiar with 101OBeX and introduce yourself to
the capabilities of the system. It provides complete access to APIs with a
maximum allowance of 500 monthly transactions so you can start your
project, with no a membership cost*.
*There is no membership fee. Transactional costs, plug-ins and other
services within the membership are not included. To exploit these
services, it will be necessary to purchase a different plan.
Starting at 50 $ per month, you will have 2 project slots with one active
project, and 5,000 monthly transactions to start your project.
Starting at 150 $ per month, you can have up to 5 projects and 2
pre-activated slots, along with 50,000 monthly transactions to launch your
business at the highest level.
Geared towards corporations requiring special configurations. Membership
activation is done through the sales team:{' '}
sales@101obex.com .
The chosen subscription type (developer, startup, business or
enterprise) that determines the configuration of the set of available
resources.
* Total project slots.
* Pre-activated projects.
* Maximum transactional volume.
* Monthly transactions.
* Storage.
* Support.
If payment is established monthly, charges will be made on the first day
of each month for the total membership amount, plus contracted add-ons and
plugins. For the first month, a prorated amount will be charged from the
plan's start date to the end of the month. If payment is established
annually, a full year of service will be charged, and renewal will occur
the day after the plan expires.
101OBeX does not invoice exempt, since it is not a possibility
contemplated in the service. If any of the elements that make up a plan
exceed its limit, the service will stop being provided.
To prevent your projects from being left without service, 101OBeX offers
the possibility of configuring alarms that will allow you to receive
notifications based on limits for each category. Although these alarms are
configurable, they have pre-established minimums to ensure that you are
always informed.
The client always has the possibility of expanding the limits for each of
the components that make up a membership through the purchasing of add-ons
or by upgrading their plan.
Clients can check their membership status in the dashboard at any time,
along with plan configuration in the Subscription Plan section of the menu
bar.
In the Settings section of the menu, an option is available to track
transaction history linked to membership collections. How to change the
payment method Payment methods can be changed from monthly to annual and
vice versa at any time. How to change the payment method At present the
only form of payment is by credit card. But you can add new cards and
change your payment method at any time.
You have the possibility to upgrade and downgrade your plan according to
your needs.
At present the only form of payment is by credit card. But you can add new
cards and change your payment method at any time.
You have the possibility to upgrade and downgrade your plan according to
your needs.

0
docs/developer.avapframework.com/1_Chat_prebind_EN_Chat_prebind_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Check_Session_EN_Check_Session_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Consultar_Solucion_EN_Consultar_Solucion_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Crear_Solucion_EN_Crear_Solucion_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Datos_Programa_de_Puntos_EN_Datos_Programa_de_Puntos_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Desplegar_preguntas_de_seguridad_EN_Desplegar_preguntas_de_seguridad_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Enviar_SMS_EN_Enviar_SMS_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_Historico_de_Ingresos_Tiempo_Aire_EN_Historico_de_Ingresos_Tiempo_Aire_EN.md Normal file
View File

0
docs/developer.avapframework.com/1_actividad_del_usuario_EN_actividad_del_usuario_EN.md Normal file
View File

34
docs/developer.avapframework.com/1_alta_baja_modificacion_alta_baja_modificacion_EN.md Normal file
View File

@ -0,0 +1,34 @@
### Where:
* status : Shows if the call has been successful (true) or not (false).
* codtran : Transaction code that identifies the executed operation.
* result : Contains information about the result of the service.
* user_id_registration : New user ID.
* longitud_otp : Length of the OTP associated with the operation.
* elapsed : Operation execution time.
### Where:
* status : Shows if the call has been successful (true) or not (false).
* level: Error importance level.
* message : Error message.
* error : Sole error code.
* Error catalogue Message Cause Email is required The parameter enviar_email_confirmar has been sent, but the parameter email has not been informed nor attached an email address The phone + prefix phone already exists The account identified by phone already exits and is activated An attempt to create an account without a phone was made Required parameter not provided phone An attempt was made to create a phone number with the wrong length The value of the parameter phone has the wrong length, depending on the country indicated in country_code An attempt was made to create an account with a prefix other than the country prefix != country_code The value of the parameter prefix does not match with the country code indicated in country_code The account <cuenta> is pending to sign the discharge The account already exists in the system, but is inactive The nick nick is already used The account identified by nick exists and it's active Country not found Controlled error in case the country code entered is wrong. We have found a problem and are working to fix it ... sorry for the inconvenience Uncontrolled error 500: Internal Server Error In order not to provide service information, a 500 error is thrown if a required parameter is not reported. 500: Internal Server Error You can also get such an error if an uncontrolled error occurs on the server Chart 2.a.2 : List of exceptions thrown by the service{' '} Alta Usuario . Business logic This section details some particularities related to this service that it is advisable to take into account.{' '} If an invalid channel_id value is provided or none is provided, the default channel (Web) is set. If an email is associated with the new user, an activation email will be sent, even if their account is automatically activated. If, on the contrary, email is not provided, there is the possibility of activating the user directly by sending the{' '} activa parameter. If it is not activated directly to the user, an SMS is sent with activation instructions. The account will remain in an inactive state until it is activated, it will not be deleted from the system at any time. If the account is already active, trying to activate it again will get a 404 error. This error is forced from the system when no registration is found to sign. The PIN is generated and sent in the first activation SMS. If the user does not activate the account or does not enter the OTP correctly, the password generated initially is reused and it is not sent in subsequent activation messages. The user's nickname can be used for the identification process (login). If nick is not indicated during the registration process, it will take the value of phone parametro. If the parameter affiliate_id is specified, the name of the same will be used in the welcome SMS, instead of using the name of the affiliate by default (Pademobile).
* Business logic This section details some particularities related to this service that it is advisable to take into account.{' '}
* If an invalid channel_id value is provided or none is provided, the default channel (Web) is set.
* If an email is associated with the new user, an activation email will be sent, even if their account is automatically activated.
* If, on the contrary, email is not provided, there is the possibility of activating the user directly by sending the{' '} activa parameter. If it is not activated directly to the user, an SMS is sent with activation instructions. The account will remain in an inactive state until it is activated, it will not be deleted from the system at any time.
* If the account is already active, trying to activate it again will get a 404 error. This error is forced from the system when no registration is found to sign.
* The PIN is generated and sent in the first activation SMS. If the user does not activate the account or does not enter the OTP correctly, the password generated initially is reused and it is not sent in subsequent activation messages.
* The user's nickname can be used for the identification process (login). If nick is not indicated during the registration process, it will take the value of phone parametro. If the parameter affiliate_id is specified, the name of the same will be used in the welcome SMS, instead of using the name of the affiliate by default (Pademobile).
This section details, for each box, all the information necessary to
exploit the previously documented services.
There is a user who has an "AFFILIATE" profile and who will
allow managing the community:
### Examples
Below are some examples of calls to the services described in this
document:

0
docs/developer.avapframework.com/1_comprobar_nick_EN_comprobar_nick_EN.md Normal file
View File

26
docs/developer.avapframework.com/1_download_101cli_download_101cli.md Normal file
View File

@ -0,0 +1,26 @@
This tool is designed to enable developers to work with the 101OBeX API.
With this tool, developers can retrieve information about their API
privileges, quotas, API Token, and more..
To begin, developers need to initialize their token using the
'init' parameter. This process involves authenticating through the
Google OAuth API to obtain the API token, which is stored locally on their
computer. Once the token is initialized, developers can use the
'info' parameter to access details about their API privileges,
projects, teams, and access token. Finally, developers have the option to
remove all downloaded information from their computer using the
'clean' parameter.
* https://github.com/101OBeXCorp/101obexcli/releases
Mac:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease-staging/101obexcli-macosx.zip
Linux:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli.-.linux.zip
Win32:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli-win32.zip

78
docs/developer.avapframework.com/29_Facturation_Facturation_System_EN.md Normal file
View File

@ -0,0 +1,78 @@
101OBeX offers different plans:
* Developer
* Startup
* Business
* Enterprise
The ideal plan to become familiar with 101OBeX and introduce yourself to
the capabilities of the system. It provides complete access to APIs with a
maximum allowance of 500 monthly transactions so you can start your
project, with no a membership cost*.
*There is no membership fee. Transactional costs, plug-ins and other
services within the membership are not included. To exploit these
services, it will be necessary to purchase a different plan.
Starting at 50 $ per month, you will have 2 project slots with one active
project, and 5,000 monthly transactions to start your project.
Starting at 150 $ per month, you can have up to 5 projects and 2
pre-activated slots, along with 50,000 monthly transactions to launch your
business at the highest level.
Geared towards corporations requiring special configurations. Membership
activation is done through the sales team:{' '}
sales@101obex.com .
The chosen subscription type (developer, startup, business or
enterprise) that determines the configuration of the set of available
resources.
* Total project slots.
* Pre-activated projects.
* Maximum transactional volume.
* Monthly transactions.
* Storage.
* Support.
If payment is established monthly, charges will be made on the first day
of each month for the total membership amount, plus contracted add-ons and
plugins. For the first month, a prorated amount will be charged from the
plan's start date to the end of the month. If payment is established
annually, a full year of service will be charged, and renewal will occur
the day after the plan expires.
101OBeX does not invoice exempt, since it is not a possibility
contemplated in the service. If any of the elements that make up a plan
exceed its limit, the service will stop being provided.
To prevent your projects from being left without service, 101OBeX offers
the possibility of configuring alarms that will allow you to receive
notifications based on limits for each category. Although these alarms are
configurable, they have pre-established minimums to ensure that you are
always informed.
The client always has the possibility of expanding the limits for each of
the components that make up a membership through the purchasing of add-ons
or by upgrading their plan.
Clients can check their membership status in the dashboard at any time,
along with plan configuration in the Subscription Plan section of the menu
bar.
In the Settings section of the menu, an option is available to track
transaction history linked to membership collections. How to change the
payment method Payment methods can be changed from monthly to annual and
vice versa at any time. How to change the payment method At present the
only form of payment is by credit card. But you can add new cards and
change your payment method at any time.
You have the possibility to upgrade and downgrade your plan according to
your needs.
At present the only form of payment is by credit card. But you can add new
cards and change your payment method at any time.
You have the possibility to upgrade and downgrade your plan according to
your needs.

0
docs/developer.avapframework.com/2_Actualizar_Programa_de_Puntos_EN_Actualizar_Programa_de_Puntos_EN.md Normal file
View File

48
docs/developer.avapframework.com/2_Add_Ons.md Normal file
View File

@ -0,0 +1,48 @@
Add-ons are collections of attributes or features that can be added to
your project. They allow for personalization, adaptation to your needs,
and optimization of usage. You can activate add-ons in different processes
throughout the acquisition of a plan or the life of a project. You can
also find in the Setting section an Add-on chapter in the settings section
dedicated exclusively to the administration of these components.
Currently, the following Add-ons are available:
Allows you to add a new empty slot to later activate a project and start
working with it. Plans have a defined limit for projects and active slots.
This add-on allows expansion to the maximum permitted slots.
Expand the volume of monthly requests in your plan and manage the total
set of requests for each of your projects. The volume of requests
available in a plan can never exceed the maximum request capacity
established in that plan.
Plans have a predefined storage capacity. For example, a Business plan has
a maximum storage capacity of 2 Teras and a default storage of 1 Gb. This
means that the storage can be increased from the default 1 Gb to 2 Teras
maximum, but no more. If more storage is required, it will be necessary to
upgrade the plan.
If your project or set of project exceed the maximum storage allowed for
the plan you have, you will need to upgrade the your plan.
Access to professional support through the 101OBeX platform's suite of
engineers.
We recommend reviewing the Pricing document for details about the pricing
configuration of the entire Add-on catalog. If a project or node reaches
the limit in any of its properties or configurations, the requests will
begin to return. To prevent this situation from causing problems in your
projects, 101OBeX is configured to support up to 10% more in each of the
configurations during the next 24 hours from the moment any of the limits
are exceeded. After this period, applications will begin to be given back.
To further prevent such scenarios, 101OBeX employs an alarm system. This
system sends notifications when specific properties approach predefined
thresholds, granting you control over your project's growth at all
times.

48
docs/developer.avapframework.com/2_Add_Ons_EN_Add_Ons_EN.md Normal file
View File

@ -0,0 +1,48 @@
Add-ons are collections of attributes or features that can be added to
your project. They allow for personalization, adaptation to your needs,
and optimization of usage. You can activate add-ons in different processes
throughout the acquisition of a plan or the life of a project. You can
also find in the Setting section an Add-on chapter in the settings section
dedicated exclusively to the administration of these components.
Currently, the following Add-ons are available:
Allows you to add a new empty slot to later activate a project and start
working with it. Plans have a defined limit for projects and active slots.
This add-on allows expansion to the maximum permitted slots.
Expand the volume of monthly requests in your plan and manage the total
set of requests for each of your projects. The volume of requests
available in a plan can never exceed the maximum request capacity
established in that plan.
Plans have a predefined storage capacity. For example, a Business plan has
a maximum storage capacity of 2 Teras and a default storage of 1 Gb. This
means that the storage can be increased from the default 1 Gb to 2 Teras
maximum, but no more. If more storage is required, it will be necessary to
upgrade the plan.
If your project or set of project exceed the maximum storage allowed for
the plan you have, you will need to upgrade the your plan.
Access to professional support through the 101OBeX platform's suite of
engineers.
We recommend reviewing the Pricing document for details about the pricing
configuration of the entire Add-on catalog. If a project or node reaches
the limit in any of its properties or configurations, the requests will
begin to return. To prevent this situation from causing problems in your
projects, 101OBeX is configured to support up to 10% more in each of the
configurations during the next 24 hours from the moment any of the limits
are exceeded. After this period, applications will begin to be given back.
To further prevent such scenarios, 101OBeX employs an alarm system. This
system sends notifications when specific properties approach predefined
thresholds, granting you control over your project's growth at all
times.

0
docs/developer.avapframework.com/2_Autorizar_Solucion_EN_Autorizar_Solucion_EN.md Normal file
View File

0
docs/developer.avapframework.com/2_Chat_Usuario_EN_Chat_Usuario_EN.md Normal file
View File

0
docs/developer.avapframework.com/2_Consultar_usuarios_de_la_solucion_EN_Consultar_usuarios_de_la_solucion_EN.md Normal file
View File

0
docs/developer.avapframework.com/2_Create_ethereum_account_create_ethereum_account.md Normal file
View File

0
docs/developer.avapframework.com/2_Enviar_Ticket_por_email_EN_Enviar_Ticket_por_email_EN.md Normal file
View File

26
docs/developer.avapframework.com/2_download_github_download_github.md Normal file
View File

@ -0,0 +1,26 @@
This tool is designed to enable developers to work with the 101OBeX API.
With this tool, developers can retrieve information about their API
privileges, quotas, API Token, and more.
To begin, developers need to initialize their token using the
'init' parameter. This process involves authenticating through the
Google OAuth API to obtain the API token, which is stored locally on their
computer. Once the token is initialized, developers can use the
'info' parameter to access details about their API privileges,
projects, teams, and access token. Finally, developers have the option to
remove all downloaded information from their computer using the
'clean' parameter.
* https://github.com/101OBeXCorp/101obexcli/releases/
Mac:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease-staging/101obexcli-macosx.zip
Linux:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli.-.linux.zip
Win32:
* https://github.com/101OBeXCorp/101obexcli/releases/download/prerelease/101obexcli-win32.zip

0
docs/developer.avapframework.com/2_get_blockchain_accounts_get_blockchain_accounts.md Normal file
View File

5
docs/developer.avapframework.com/31_github_github_cli.md Normal file
View File

@ -0,0 +1,5 @@
This tool is designed to enable developers to work with the 101OBeX API.
With this tool, developers can retrieve information about their API
privileges, quotas, API Token, and more.
https://github.com/101OBeXCorp/101obexcli

17
docs/developer.avapframework.com/32_indice_Indice de Servicios_EN.md Normal file
View File

@ -0,0 +1,17 @@
* Management Console: FILE PROCEDURE URL `admin.py` actividad_usuarios /ws/admin.py/actividad_usuarios `admin.py` actualizardatosusuarios /ws/admin.py/actualizardatosusuarios `admin.py` administrar_solicitud_kyc /ws/admin.py/administrar_solicitud_kyc `admin.py` afiliadoscontipo /ws/admin.py/afiliadoscontipo `admin.py` altaadmin /ws/admin.py/altaadmin `admin.py` altaafiliado /ws/admin.py/altaafiliado `admin.py` cambiarcertificacion /ws/admin.py/cambiarcertificacion `admin.py` cambiarperfilusuario /ws/admin.py/cambiarperfilusuario `admin.py` certificarkyc /ws/admin.py/certificarkyc `admin.py` confirmaringreso /ws/admin.py/confirmaringreso `admin.py` cuadrodemando /ws/admin.py/cuadrodemando `admin.py` datoscuenta /ws/admin.py/datoscuenta `admin.py` editorperfiles /ws/admin.py/editorperfiles `admin.py` histconfirmaciones /ws/admin.py/histconfirmaciones `admin.py` histingresosta /ws/admin.py/histingresosta `admin.py` informesadmin /ws/admin.py/informesadmin `admin.py` ingresofondosta /ws/admin.py/ingresofondosta `admin.py` listado_kyc /ws/admin.py/listado_kyc `admin.py` operaciones /ws/admin.py/operaciones `admin.py` prefondeo /ws/admin.py/prefondeo `admin.py` revert /ws/admin.py/revert `admin.py` revisarorigendefondos /ws/admin.py/revisarorigendefondos `admin.py` revocar_kyc /ws/admin.py/revocar_kyc `admin.py` saldota /ws/admin.py/saldota `admin.py` saldousuarioafecha /ws/admin.py/saldousuarioafecha `admin.py` setgetconfig /ws/admin.py/setgetconfig `admin.py` transacciones /ws/admin.py/transacciones `admin.py` usuariosconsaldo /ws/admin.py/usuariosconsaldo `afiliados.py` comisionesafiliado /ws/afiliados.py/comisionesafiliado `afiliados.py` consultatransacciones /ws/afiliados.py/consultatransacciones `afiliados.py` dashboardafiliado /ws/afiliados.py/dashboardafiliado `afiliados.py` devolucion /ws/afiliados.py/devolucion `afiliados.py` resumencomisionesafiliado /ws/afiliados.py/resumencomisionesafiliado `clearing.py` index /ws/clearing.py/index `liquidacion.py` liquidacionafiliado /ws/liquidacion.py/liquidacionafiliado `divisas.py` actualizar /ws/divisas.py/actualizar `listanegra.py` listado /ws/listanegra.py/listado `listanegra.py` poner /ws/listanegra.py/poner `listanegra.py` quitar /ws/listanegra.py/quitar `impersonar.py` enviodinero /ws/impersonar.py/enviodinero `comunidad.py` altacomunidad /ws/comunidad.py/altacomunidad `bloqueos.py` bloquear /ws/bloqueos.py/bloquear `bloqueos.py` desbloquear /ws/bloqueos.py/desbloquear `bloqueos.py` listado /ws/bloqueos.py/listado `util.py` informes /ws/util.py/informes `util.py` bancos_agregadorfinanciero /ws/util.py/bancos_agregadorfinanciero
* Commons: FILE PROCEDURE URL `divisas.py` listado /ws/divisas.py/listado `firma.py` firmar /ws/firma.py/firmar `util.py` get_caracteristicas /ws/util.py/get_caracteristicas `util.py` provincias /ws/util.py/provincias `util.py` paises /ws/util.py/paises `util.py` perfiles /ws/util.py/perfiles `util.py` operadores /ws/util.py/operadores `util.py` afiliados /ws/util.py/afiliados `util.py` get_importe_transaccion /ws/util.py/get_importe_transaccion `users.py` login /ws/users.py/login `users.py` logout /ws/users.py/logout `users.py` loginonline /ws/users.py/loginonline `users.py` logintpv /ws/users.py/logintpv `users.py` checksession /ws/users.py/checksession `users.py` compruebasesion /ws/users.py/compruebasesion
* Loyalty: FILE PROCEDURE URL `donaciones.py` depositotarjetaydonar /ws/donaciones.py/depositotarjetaydonar `donaciones.py` donar /ws/donaciones.py/donar `donaciones.py` donartarjeta /ws/donaciones.py/donartarjeta `donaciones.py` get_caracteristica /ws/donaciones.py/get_caracteristica `programadepuntos.py` actualizar /ws/programadepuntos.py/actualizar `programadepuntos.py` crear /ws/programadepuntos.py/crear `programadepuntos.py` datos /ws/programadepuntos.py/datos `programadepuntos.py` listado /ws/programadepuntos.py/listado `programadepuntos.py` listado_usuarios /ws/programadepuntos.py/listado_usuarios `movimientos.py` canjear_puntos /ws/movimientos.py/canjear_puntos
* Checkout: FILE PROCEDURE URL `granemisor.py` listado /ws/granemisor.py/listado `granemisor.py` transferencia /ws/granemisor.py/transferencia `pagodeservicios.py` enviarticketemail /ws/pagodeservicios.py/enviarticketemail `pagodeservicios.py` infoservicio /ws/pagodeservicios.py/infoservicio `pagodeservicios.py` listaservicios /ws/pagodeservicios.py/listaservicios `pagodeservicios.py` pagarservicio /ws/pagodeservicios.py/pagarservicio `pagodeservicios.py` pagarserviciotarjeta /ws/pagodeservicios.py/pagarserviciotarjeta `pagoderecibosv2.py` firmar /ws/pagoderecibosv2.py/firmar `pagoderecibosv2.py` firmar_original /ws/pagoderecibosv2.py/firmar_original `pagoderecibosv2.py` info /ws/pagoderecibosv2.py/info `pagoderecibosv2.py` lista /ws/pagoderecibosv2.py/lista `pagoderecibosv2.py` pagar /ws/pagoderecibosv2.py/pagar `pagodiferido.py` pagodiferido /ws/pagodiferido.py/pagodiferido `util.py` precios_servicio /ws/util.py/precios_servicio `pagomovil.py` pagomovil /ws/pagomovil.py/pagomovil `tiempoaire.py` recargar /ws/tiempoaire.py/recargar
* Wallet: FILE PROCEDURE URL `origenesdefondos.py` gestor_origenes_propios /ws/origenesdefondos.py/gestor_origenes_propios `cuentas.py` saldo /ws/cuentas.py/saldo `movimientos.py` actividad /ws/movimientos.py/actividad `movimientos.py` listado /ws/movimientos.py/listado
* Notifications: FILE PROCEDURE URL `movimientos.py` enviarsms /ws/movimientos.py/enviarsms `sms.py` procesarpeticion /ws/sms.py/procesarpeticion `sms.py` tecnophone2_notificacion_envio /ws/sms.py/tecnophone2_notificacion_envio `notificaciones.py` gestor_notificaciones /ws/notificaciones.py/gestor_notificaciones `notificaciones.py` leer_notificaciones /ws/notificaciones.py/leer_notificaciones `notificaciones.py` leer_uno /ws/notificaciones.py/leer_uno `notificaciones.py` numero_no_leidos /ws/notificaciones.py/numero_no_leidos `alarmas.py` crearalarma /ws/alarmas.py/crearalarma `alarmas.py` desempaquetar /ws/alarmas.py/desempaquetar `push_notifications.py` apn_dispositivo /ws/push_notifications.py/apn_dispositivo `push_notifications.py` apn_dispositivos_con_app_id /ws/push_notifications.py/ apn_dispositivos_con_app_id `push_notifications.py` asociar_device_token /ws/push_notifications.py/asociar_device_token `push_notifications.py` reiniciar_badges /ws/push_notifications.py/reiniciar_badges
* Onboarding: FILE PROCEDURE URL NOTES `cuentas.py` alta /ws/cuentas.py/alta `cuentas.py` baja /ws/cuentas.py/baja `cuentas.py` parar /ws/cuentas.py/parar `cuentas.py` activar /ws/cuentas.py/activar `users.py` alta_cliente /ws/users.py/alta_cliente `users.py` certificarcuenta /ws/users.py/certificarcuenta `users.py` acreditar_nivel_kyc /ws/users.py/acreditar_nivel_kyc `users.py` alta_kyc /ws/users.py/alta_kyc `users.py` campos_alta_cliente /ws/users.py/campos_alta_cliente `users.py` reenviarotpalta /ws/users.py/reenviarotpalta `seguridad_itf.py` condiciones_legales /ws/seguridad_itf.py/condiciones_legales `seguridad_itf.py` preguntas_de_seguridad /ws/seguridad_itf.py/preguntas_de_seguridad `netverify.py` certificar /ws/netverify.py/certificar `netverify.py` certificarcertify /ws/netverify.py/certificarcertify `netverify.py` finalizar /ws/netverify.py/finalizar `netverify.py` listado /ws/netverify.py/listado `netverify.py` revocar /ws/netverify.py/revocar `netverify.py` solicitar /ws/netverify.py/solicitar `users.py` cambiodedatos /ws/users.py/cambiodedatos `users.py` cambioperfilcontrolado /ws/users.py/cambioperfilcontrolado `users.py` checknick /ws/users.py/checknick `users.py` data /ws/users.py/data `users.py` firmarconclaveprivada /ws/users.py/firmarconclaveprivada `users.py` get_photo /ws/users.py/get_photo `users.py` info_usuario /ws/users.py/info_usuario `users.py` restartpin /ws/users.py/restartpin `users.py` upload_photo /ws/users.py/upload_photo `mls.py` activar /ws/mls.py/activar `carga_masiva.py` usuarios_ctm /ws/carga_masiva.py/usuarios_ctm Alta masiva de usuarios ctm
* Remittance (Money movements): FILE PROCEDURE URL NOTES `movimientos.py` anularcomprartarjeta /ws/movimientos.py/anularcomprartarjeta `movimientos.py` comprar /ws/movimientos.py/comprar `movimientos.py` comprartarjeta /ws/movimientos.py/comprartarjeta `movimientos.py` depositotarjeta /ws/movimientos.py/depositotarjeta `movimientos.py` depositotarjetaotracuenta /ws/movimientos.py/depositotarjetaotracuenta `movimientos.py` entreorigenes /ws/movimientos.py/entreorigenes `movimientos.py` enviar /ws/movimientos.py/enviar `movimientos.py` enviarhalcash /ws/movimientos.py/enviarhalcash `movimientos.py` enviosderegalo /ws/movimientos.py/enviosderegalo `movimientos.py` pedir /ws/movimientos.py/pedir `movimientos.py` recargar /ws/movimientos.py/recargar `movimientos.py` remesadirigida /ws/movimientos.py/remesadirigida `movimientos.py` repetirtransaccion /ws/movimientos.py/repetirtransaccion `movimientos.py` retirar /ws/movimientos.py/retirar `movimientos.py` retirarbanco /ws/movimientos.py/retirarbanco `pademobile_prepago.py` consultar_saldo_prepago /ws/pademobile_prepago.py/consultar_saldo_prepago `pademobile_prepago.py` ingresar_prepago /ws/pademobile_prepago.py/ingresar_prepago `pademobile_prepago.py` registrar_monedero_prepago /ws/pademobile_prepago.py/ registrar_monedero_prepago `pademobile_prepago.py` retirar_prepago /ws/pademobile_prepago.py/retirar_prepago `movimientos.py` transferenciasmasivas /ws/movimientos.py/transferenciasmasivas `util.py` carga_masiva_ctm /ws/util.py/carga_masiva_ctm Carga masiva de saldos a usuarios CTM
* ...: FILE PROCEDURE URL `movimientos.py` comprobartransaccion /ws/movimientos.py/comprobartransaccion `movimientos.py` consultatransaccion /ws/movimientos.py/consultatransaccion `movimientos.py` datos_transaccion /ws/movimientos.py/datos_transaccion `shake.py` ejecutar /ws/shake.py/ejecutar `shake.py` obtener /ws/shake.py/obtener `shakev2.py` ejecutar /ws/shakev2.py/ejecutar `shakev2.py` obtener /ws/shakev2.py/obtener `chat.py` chat_operator /ws/chat.py/chat_operator `chat.py` chat_user /ws/chat.py/chat_user `chat.py` prebind /ws/chat.py/prebind `util.py` logs /ws/util.py/logs `util.py` template_informes /ws/util.py/template_informes .

17
docs/developer.avapframework.com/32_indice_Indice_de_Servicios_Documentados_EN.md Normal file
View File

@ -0,0 +1,17 @@
* Management Console: FILE PROCEDURE URL FILES `admin.py` actividad_usuarios /ws/admin.py/actividad_usuarios `admin.py` actualizardatosusuarios /ws/admin.py/actualizardatosusuarios `admin.py` administrar_solicitud_kyc /ws/admin.py/administrar_solicitud_kyc `admin.py` afiliadoscontipo /ws/admin.py/afiliadoscontipo `admin.py` altaadmin /ws/admin.py/altaadmin `admin.py` altaafiliado /ws/admin.py/altaafiliado `admin.py` cambiarcertificacion /ws/admin.py/cambiarcertificacion `admin.py` cambiarperfilusuario /ws/admin.py/cambiarperfilusuario `admin.py` certificarkyc /ws/admin.py/certificarkyc `admin.py` confirmaringreso /ws/admin.py/confirmaringreso `admin.py` cuadrodemando /ws/admin.py/cuadrodemando `admin.py` datoscuenta /ws/admin.py/datoscuenta `admin.py` editorperfiles /ws/admin.py/editorperfiles `admin.py` histconfirmaciones /ws/admin.py/histconfirmaciones `admin.py` histingresosta /ws/admin.py/histingresosta `admin.py` informesadmin /ws/admin.py/informesadmin `admin.py` ingresofondosta /ws/admin.py/ingresofondosta `admin.py` listado_kyc /ws/admin.py/listado_kyc `admin.py` operaciones /ws/admin.py/operaciones `admin.py` prefondeo /ws/admin.py/prefondeo `admin.py` revert /ws/admin.py/revert `admin.py` revisarorigendefondos /ws/admin.py/revisarorigendefondos `admin.py` revocar_kyc /ws/admin.py/revocar_kyc `admin.py` saldota /ws/admin.py/saldota `admin.py` saldousuarioafecha /ws/admin.py/saldousuarioafecha `admin.py` setgetconfig /ws/admin.py/setgetconfig `admin.py` transacciones /ws/admin.py/transacciones `admin.py` usuariosconsaldo /ws/admin.py/usuariosconsaldo `afiliados.py` comisionesafiliado /ws/afiliados.py/comisionesafiliado `afiliados.py` consultatransacciones /ws/afiliados.py/consultatransacciones `afiliados.py` dashboardafiliado /ws/afiliados.py/dashboardafiliado `afiliados.py` devolucion /ws/afiliados.py/devolucion `afiliados.py` resumencomisionesafiliado /ws/afiliados.py/resumencomisionesafiliado `clearing.py` index /ws/clearing.py/index `liquidacion.py` liquidacionafiliado /ws/liquidacion.py/liquidacionafiliado `divisas.py` actualizar /ws/divisas.py/actualizar `listanegra.py` listado /ws/listanegra.py/listado `listanegra.py` poner /ws/listanegra.py/poner `listanegra.py` quitar /ws/listanegra.py/quitar `impersonar.py` enviodinero /ws/impersonar.py/enviodinero `comunidad.py` altacomunidad /ws/comunidad.py/altacomunidad `bloqueos.py` bloquear /ws/bloqueos.py/bloquear `bloqueos.py` desbloquear /ws/bloqueos.py/desbloquear `bloqueos.py` listado /ws/bloqueos.py/listado `util.py` informes /ws/util.py/informes `util.py` bancos_agregadorfinanciero /ws/util.py/bancos_agregadorfinanciero
* Tools: FILE PROCEDURE URL FILED `divisas.py` listado /ws/divisas.py/listado X `firma.py` firmar /ws/firma.py/firmar X `util.py` get_caracteristicas /ws/util.py/get_caracteristicas `util.py` provincias /ws/util.py/provincias `util.py` paises /ws/util.py/paises `util.py` perfiles /ws/util.py/perfiles `util.py` operadores /ws/util.py/operadores `util.py` afiliados /ws/util.py/afiliados `util.py` get_importe_transaccion /ws/util.py/get_importe_transaccion `users.py` login /ws/users.py/login X `Accesos` `users.py` logout /ws/users.py/logout `users.py` loginonline /ws/users.py/loginonline `users.py` logintpv /ws/users.py/logintpv `users.py` checksession /ws/users.py/checksession `users.py` compruebasesion /ws/users.py/compruebasesion
* Loyalty: FILE PROCEDURE URL FILED `donaciones.py` depositotarjetaydonar /ws/donaciones.py/depositotarjetaydonar `donaciones.py` donar /ws/donaciones.py/donar `donaciones.py` donartarjeta /ws/donaciones.py/donartarjeta `donaciones.py` get_caracteristica /ws/donaciones.py/get_caracteristica `programadepuntos.py` actualizar /ws/programadepuntos.py/actualizar `programadepuntos.py` crear /ws/programadepuntos.py/crear `programadepuntos.py` datos /ws/programadepuntos.py/datos `programadepuntos.py` listado /ws/programadepuntos.py/listado `programadepuntos.py` listado_usuarios /ws/programadepuntos.py/listado_usuarios `movimientos.py` canjear_puntos /ws/movimientos.py/canjear_puntos
* Checkout: FILE PROCEDURE URL FILED `granemisor.py` listado /ws/granemisor.py/listado `granemisor.py` transferencia /ws/granemisor.py/transferencia `pagodeservicios.py` enviarticketemail /ws/pagodeservicios.py/enviarticketemail `pagodeservicios.py` infoservicio /ws/pagodeservicios.py/infoservicio X `Bills2` `pagodeservicios.py` listaservicios /ws/pagodeservicios.py/listaservicios X `Bills2` `pagodeservicios.py` pagarservicio /ws/pagodeservicios.py/pagarservicio X `Bills2` `pagodeservicios.py` pagarserviciotarjeta /ws/pagodeservicios.py/pagarserviciotarjeta `pagoderecibosv2.py` firmar /ws/pagoderecibosv2.py/firmar `pagoderecibosv2.py` firmar_original /ws/pagoderecibosv2.py/firmar_original `pagoderecibosv2.py` info /ws/pagoderecibosv2.py/info X `Bills2` `pagoderecibosv2.py` lista /ws/pagoderecibosv2.py/lista X `Bills2` `pagoderecibosv2.py` pagar /ws/pagoderecibosv2.py/pagar X `Bills2` `pagodiferido.py` pagodiferido /ws/pagodiferido.py/pagodiferido `util.py` precios_servicio /ws/util.py/precios_servicio `pagomovil.py` pagomovil /ws/pagomovil.py/pagomovil `tiempoaire.py` recargar /ws/tiempoaire.py/recargar Se ejecuta a traves de `pagodeservicios.py`
* Wallet: FILE PROCEDURE URL NOTES FILED `origenesdefondos.py` gestor_origenes_propios /ws/origenesdefondos.py/gestor_origenes_propios Hay que dividirlo en 7 endpoints diferentes X `origenes_de_fondos` `cuentas.py` saldo /ws/cuentas.py/saldo `movimientos.py` actividad /ws/movimientos.py/actividad X `movimientos.py` listado /ws/movimientos.py/listado X
* Notifications: FILE PROCEDURE URL FILED `movimientos.py` enviarsms /ws/movimientos.py/enviarsms `sms.py` procesarpeticion /ws/sms.py/procesarpeticion `sms.py` tecnophone2_notificacion_envio /ws/sms.py/tecnophone2_notificacion_envio `notificaciones.py` gestor_notificaciones /ws/notificaciones.py/gestor_notificaciones `notificaciones.py` leer_notificaciones /ws/notificaciones.py/leer_notificaciones `notificaciones.py` leer_uno /ws/notificaciones.py/leer_uno `notificaciones.py` numero_no_leidos /ws/notificaciones.py/numero_no_leidos `alarmas.py` crearalarma /ws/alarmas.py/crearalarma `alarmas.py` desempaquetar /ws/alarmas.py/desempaquetar `push_notifications.py` apn_dispositivo /ws/push_notifications.py/apn_dispositivo `push_notifications.py` apn_dispositivos_con_app_id /ws/push_notifications.py/ apn_dispositivos_con_app_id `push_notifications.py` asociar_device_token /ws/push_notifications.py/asociar_device_token `push_notifications.py` reiniciar_badges /ws/push_notifications.py/reiniciar_badges
* Onboarding: FILE PROCEDURE URL NOTES FILED `cuentas.py` alta /ws/cuentas.py/alta X `alta_baja_modificacion` `cuentas.py` baja /ws/cuentas.py/baja X `alta_baja_modificacion` `cuentas.py` parar /ws/cuentas.py/parar `cuentas.py` activar /ws/cuentas.py/activar `users.py` alta_cliente /ws/users.py/alta_cliente `users.py` certificarcuenta /ws/users.py/certificarcuenta `users.py` acreditar_nivel_kyc /ws/users.py/acreditar_nivel_kyc `users.py` alta_kyc /ws/users.py/alta_kyc `users.py` campos_alta_cliente /ws/users.py/campos_alta_cliente `users.py` reenviarotpalta /ws/users.py/reenviarotpalta `seguridad_itf.py` condiciones_legales /ws/seguridad_itf.py/condiciones_legales `seguridad_itf.py` preguntas_de_seguridad /ws/seguridad_itf.py/preguntas_de_seguridad `netverify.py` certificar /ws/netverify.py/certificar `netverify.py` certificarcertify /ws/netverify.py/certificarcertify `netverify.py` finalizar /ws/netverify.py/finalizar `netverify.py` listado /ws/netverify.py/listado `netverify.py` revocar /ws/netverify.py/revocar `netverify.py` solicitar /ws/netverify.py/solicitar `users.py` cambiodedatos /ws/users.py/cambiodedatos X `alta_baja_modificacion` `users.py` cambioperfilcontrolado /ws/users.py/cambioperfilcontrolado `users.py` checknick /ws/users.py/checknick X `users.py` data /ws/users.py/data `users.py` firmarconclaveprivada /ws/users.py/firmarconclaveprivada `users.py` get_photo /ws/users.py/get_photo `users.py` info_usuario /ws/users.py/info_usuario `users.py` restartpin /ws/users.py/restartpin `users.py` upload_photo /ws/users.py/upload_photo `mls.py` activar /ws/mls.py/activar `carga_masiva.py` usuarios_ctm /ws/carga_masiva.py/usuarios_ctm Alta masiva de usuarios ctm
* Remittance (Money movements): FILE PROCEDURE URL NOTES FILED `movimientos.py` anularcomprartarjeta /ws/movimientos.py/anularcomprartarjeta X `Interfaz Servicios Pagos` `movimientos.py` comprar /ws/movimientos.py/comprar `movimientos.py` comprartarjeta /ws/movimientos.py/comprartarjeta X `Interfaz Servicios Pagos` `movimientos.py` depositotarjeta /ws/movimientos.py/depositotarjeta `movimientos.py` depositotarjetaotracuenta /ws/movimientos.py/depositotarjetaotracuenta `movimientos.py` entreorigenes /ws/movimientos.py/entreorigenes `movimientos.py` enviar /ws/movimientos.py/enviar X `movimientos.py` enviarhalcash /ws/movimientos.py/enviarhalcash `movimientos.py` enviosderegalo /ws/movimientos.py/enviosderegalo `movimientos.py` pedir /ws/movimientos.py/pedir X `movimientos.py` recargar /ws/movimientos.py/recargar `movimientos.py` remesadirigida /ws/movimientos.py/remesadirigida `movimientos.py` repetirtransaccion /ws/movimientos.py/repetirtransaccion X Falta revisar la repeticion de `tiempoaire.py` `movimientos.py` retirar /ws/movimientos.py/retirar `movimientos.py` retirarbanco /ws/movimientos.py/retirarbanco `pademobile_prepago.py` consultar_saldo_prepago /ws/pademobile_prepago.py/consultar_saldo_prepago `pademobile_prepago.py` ingresar_prepago /ws/pademobile_prepago.py/ingresar_prepago `pademobile_prepago.py` registrar_monedero_prepago /ws/pademobile_prepago.py/ registrar_monedero_prepago `pademobile_prepago.py` retirar_prepago /ws/pademobile_prepago.py/retirar_prepago `movimientos.py` transferenciasmasivas /ws/movimientos.py/transferenciasmasivas `util.py` carga_masiva_ctm /ws/util.py/carga_masiva_ctm Carga masiva de saldos a usuarios CTM
* ...: FILE PROCEDURE URL FILED `movimientos.py` comprobartransaccion /ws/movimientos.py/comprobartransaccion `movimientos.py` consultatransaccion /ws/movimientos.py/consultatransaccion X Esta mal la URL indicada en{' '} `Interfaz Servicios Pagos` `movimientos.py` datos_transaccion /ws/movimientos.py/datos_transaccion `shake.py` ejecutar /ws/shake.py/ejecutar `shake.py` obtener /ws/shake.py/obtener `shakev2.py` ejecutar /ws/shakev2.py/ejecutar `shakev2.py` obtener /ws/shakev2.py/obtener `chat.py` chat_operator /ws/chat.py/chat_operator `chat.py` chat_user /ws/chat.py/chat_user `chat.py` prebind /ws/chat.py/prebind `util.py` logs /ws/util.py/logs `util.py` template_informes /ws/util.py/template_informes

17
docs/developer.avapframework.com/32_indice_Indice_de_Servicios_OLD_EN.md Normal file
View File

@ -0,0 +1,17 @@
* Management Console: FILE PROCEDURE URL `admin.py` actividad_usuarios /ws/admin.py/actividad_usuarios `admin.py` actualizardatosusuarios /ws/admin.py/actualizardatosusuarios `admin.py` administrar_solicitud_kyc /ws/admin.py/administrar_solicitud_kyc `admin.py` afiliadoscontipo /ws/admin.py/afiliadoscontipo `admin.py` altaadmin /ws/admin.py/altaadmin `admin.py` altaafiliado /ws/admin.py/altaafiliado `admin.py` cambiarcertificacion /ws/admin.py/cambiarcertificacion `admin.py` cambiarperfilusuario /ws/admin.py/cambiarperfilusuario `admin.py` certificarkyc /ws/admin.py/certificarkyc `admin.py` confirmaringreso /ws/admin.py/confirmaringreso `admin.py` cuadrodemando /ws/admin.py/cuadrodemando `admin.py` datoscuenta /ws/admin.py/datoscuenta `admin.py` editorperfiles /ws/admin.py/editorperfiles `admin.py` histconfirmaciones /ws/admin.py/histconfirmaciones `admin.py` histingresosta /ws/admin.py/histingresosta `admin.py` informesadmin /ws/admin.py/informesadmin `admin.py` ingresofondosta /ws/admin.py/ingresofondosta `admin.py` listado_kyc /ws/admin.py/listado_kyc `admin.py` operaciones /ws/admin.py/operaciones `admin.py` prefondeo /ws/admin.py/prefondeo `admin.py` revert /ws/admin.py/revert `admin.py` revisarorigendefondos /ws/admin.py/revisarorigendefondos `admin.py` revocar_kyc /ws/admin.py/revocar_kyc `admin.py` saldota /ws/admin.py/saldota `admin.py` saldousuarioafecha /ws/admin.py/saldousuarioafecha `admin.py` setgetconfig /ws/admin.py/setgetconfig `admin.py` transacciones /ws/admin.py/transacciones `admin.py` usuariosconsaldo /ws/admin.py/usuariosconsaldo `afiliados.py` comisionesafiliado /ws/afiliados.py/comisionesafiliado `afiliados.py` consultatransacciones /ws/afiliados.py/consultatransacciones `afiliados.py` dashboardafiliado /ws/afiliados.py/dashboardafiliado `afiliados.py` devolucion /ws/afiliados.py/devolucion `afiliados.py` resumencomisionesafiliado /ws/afiliados.py/resumencomisionesafiliado `clearing.py` index /ws/clearing.py/index `liquidacion.py` liquidacionafiliado /ws/liquidacion.py/liquidacionafiliado `divisas.py` actualizar /ws/divisas.py/actualizar `listanegra.py` listado /ws/listanegra.py/listado `listanegra.py` poner /ws/listanegra.py/poner `listanegra.py` quitar /ws/listanegra.py/quitar `impersonar.py` enviodinero /ws/impersonar.py/enviodinero `comunidad.py` altacomunidad /ws/comunidad.py/altacomunidad `bloqueos.py` bloquear /ws/bloqueos.py/bloquear `bloqueos.py` desbloquear /ws/bloqueos.py/desbloquear `bloqueos.py` listado /ws/bloqueos.py/listado `util.py` informes /ws/util.py/informes `util.py` bancos_agregadorfinanciero /ws/util.py/bancos_agregadorfinanciero
* Tools: FILE PROCEDURE URL `divisas.py` listado /ws/divisas.py/listado `firma.py` firmar /ws/firma.py/firmar `util.py` get_caracteristicas /ws/util.py/get_caracteristicas `util.py` provincias /ws/util.py/provincias `util.py` paises /ws/util.py/paises `util.py` perfiles /ws/util.py/perfiles `util.py` operadores /ws/util.py/operadores `util.py` afiliados /ws/util.py/afiliados `util.py` get_importe_transaccion /ws/util.py/get_importe_transaccion `users.py` login /ws/users.py/login `users.py` logout /ws/users.py/logout `users.py` loginonline /ws/users.py/loginonline `users.py` logintpv /ws/users.py/logintpv `users.py` checksession /ws/users.py/checksession `users.py` compruebasesion /ws/users.py/compruebasesion
* Loyalty: FILE PROCEDURE URL `donaciones.py` depositotarjetaydonar /ws/donaciones.py/depositotarjetaydonar `donaciones.py` donar /ws/donaciones.py/donar `donaciones.py` donartarjeta /ws/donaciones.py/donartarjeta `donaciones.py` get_caracteristica /ws/donaciones.py/get_caracteristica `programadepuntos.py` actualizar /ws/programadepuntos.py/actualizar `programadepuntos.py` crear /ws/programadepuntos.py/crear `programadepuntos.py` datos /ws/programadepuntos.py/datos `programadepuntos.py` listado /ws/programadepuntos.py/listado `programadepuntos.py` listado_usuarios /ws/programadepuntos.py/listado_usuarios `movimientos.py` canjear_puntos /ws/movimientos.py/canjear_puntos
* Checkout: FILE PROCEDURE URL `granemisor.py` listado /ws/granemisor.py/listado `granemisor.py` transferencia /ws/granemisor.py/transferencia `pagodeservicios.py` enviarticketemail /ws/pagodeservicios.py/enviarticketemail `pagodeservicios.py` infoservicio /ws/pagodeservicios.py/infoservicio `pagodeservicios.py` listaservicios /ws/pagodeservicios.py/listaservicios `pagodeservicios.py` pagarservicio /ws/pagodeservicios.py/pagarservicio `pagodeservicios.py` pagarserviciotarjeta /ws/pagodeservicios.py/pagarserviciotarjeta `pagoderecibosv2.py` firmar /ws/pagoderecibosv2.py/firmar `pagoderecibosv2.py` firmar_original /ws/pagoderecibosv2.py/firmar_original `pagoderecibosv2.py` info /ws/pagoderecibosv2.py/info `pagoderecibosv2.py` lista /ws/pagoderecibosv2.py/lista `pagoderecibosv2.py` pagar /ws/pagoderecibosv2.py/pagar `pagodiferido.py` pagodiferido /ws/pagodiferido.py/pagodiferido `util.py` precios_servicio /ws/util.py/precios_servicio `pagomovil.py` pagomovil /ws/pagomovil.py/pagomovil `tiempoaire.py` recargar /ws/tiempoaire.py/recargar
* Wallet: FILE PROCEDURE URL NOTES `origenesdefondos.py` gestor_origenes_propios /ws/origenesdefondos.py/gestor_origenes_propios Hay que dividirlo en 7 endpoints diferentes `cuentas.py` saldo /ws/cuentas.py/saldo `movimientos.py` actividad /ws/movimientos.py/actividad `movimientos.py` listado /ws/movimientos.py/listado
* Notifications: FILE PROCEDURE URL `movimientos.py` enviarsms /ws/movimientos.py/enviarsms `sms.py` procesarpeticion /ws/sms.py/procesarpeticion `sms.py` tecnophone2_notificacion_envio /ws/sms.py/tecnophone2_notificacion_envio `notificaciones.py` gestor_notificaciones /ws/notificaciones.py/gestor_notificaciones `notificaciones.py` leer_notificaciones /ws/notificaciones.py/leer_notificaciones `notificaciones.py` leer_uno /ws/notificaciones.py/leer_uno `notificaciones.py` numero_no_leidos /ws/notificaciones.py/numero_no_leidos `alarmas.py` crearalarma /ws/alarmas.py/crearalarma `alarmas.py` desempaquetar /ws/alarmas.py/desempaquetar `push_notifications.py` apn_dispositivo /ws/push_notifications.py/apn_dispositivo `push_notifications.py` apn_dispositivos_con_app_id /ws/push_notifications.py/ apn_dispositivos_con_app_id `push_notifications.py` asociar_device_token /ws/push_notifications.py/asociar_device_token `push_notifications.py` reiniciar_badges /ws/push_notifications.py/reiniciar_badges
* Onboarding: FILE PROCEDURE URL NOTES `cuentas.py` alta /ws/cuentas.py/alta `cuentas.py` baja /ws/cuentas.py/baja `cuentas.py` parar /ws/cuentas.py/parar `cuentas.py` activar /ws/cuentas.py/activar `users.py` alta_cliente /ws/users.py/alta_cliente `users.py` certificarcuenta /ws/users.py/certificarcuenta `users.py` acreditar_nivel_kyc /ws/users.py/acreditar_nivel_kyc `users.py` alta_kyc /ws/users.py/alta_kyc `users.py` campos_alta_cliente /ws/users.py/campos_alta_cliente `users.py` reenviarotpalta /ws/users.py/reenviarotpalta `seguridad_itf.py` condiciones_legales /ws/seguridad_itf.py/condiciones_legales `seguridad_itf.py` preguntas_de_seguridad /ws/seguridad_itf.py/preguntas_de_seguridad `netverify.py` certificar /ws/netverify.py/certificar `netverify.py` certificarcertify /ws/netverify.py/certificarcertify `netverify.py` finalizar /ws/netverify.py/finalizar `netverify.py` listado /ws/netverify.py/listado `netverify.py` revocar /ws/netverify.py/revocar `netverify.py` solicitar /ws/netverify.py/solicitar `users.py` cambiodedatos /ws/users.py/cambiodedatos `users.py` cambioperfilcontrolado /ws/users.py/cambioperfilcontrolado `users.py` checknick /ws/users.py/checknick `users.py` data /ws/users.py/data `users.py` firmarconclaveprivada /ws/users.py/firmarconclaveprivada `users.py` get_photo /ws/users.py/get_photo `users.py` info_usuario /ws/users.py/info_usuario `users.py` restartpin /ws/users.py/restartpin `users.py` upload_photo /ws/users.py/upload_photo `mls.py` activar /ws/mls.py/activar `carga_masiva.py` usuarios_ctm /ws/carga_masiva.py/usuarios_ctm Alta masiva de usuarios ctm
* Remittance (Money movements): FILE PROCEDURE URL NOTES `movimientos.py` anularcomprartarjeta /ws/movimientos.py/anularcomprartarjeta `movimientos.py` comprar /ws/movimientos.py/comprar `movimientos.py` comprartarjeta /ws/movimientos.py/comprartarjeta `movimientos.py` depositotarjeta /ws/movimientos.py/depositotarjeta `movimientos.py` depositotarjetaotracuenta /ws/movimientos.py/depositotarjetaotracuenta `movimientos.py` entreorigenes /ws/movimientos.py/entreorigenes `movimientos.py` enviar /ws/movimientos.py/enviar `movimientos.py` enviarhalcash /ws/movimientos.py/enviarhalcash `movimientos.py` enviosderegalo /ws/movimientos.py/enviosderegalo `movimientos.py` pedir /ws/movimientos.py/pedir `movimientos.py` recargar /ws/movimientos.py/recargar `movimientos.py` remesadirigida /ws/movimientos.py/remesadirigida `movimientos.py` repetirtransaccion /ws/movimientos.py/repetirtransaccion `movimientos.py` retirar /ws/movimientos.py/retirar `movimientos.py` retirarbanco /ws/movimientos.py/retirarbanco `pademobile_prepago.py` consultar_saldo_prepago /ws/pademobile_prepago.py/consultar_saldo_prepago `pademobile_prepago.py` ingresar_prepago /ws/pademobile_prepago.py/ingresar_prepago `pademobile_prepago.py` registrar_monedero_prepago /ws/pademobile_prepago.py/ registrar_monedero_prepago `pademobile_prepago.py` retirar_prepago /ws/pademobile_prepago.py/retirar_prepago `movimientos.py` transferenciasmasivas /ws/movimientos.py/transferenciasmasivas `util.py` carga_masiva_ctm /ws/util.py/carga_masiva_ctm Carga masiva de saldos a usuarios CTM
* ...:(?) FILE PROCEDURE URL `movimientos.py` comprobartransaccion /ws/movimientos.py/comprobartransaccion `movimientos.py` consultatransaccion /ws/movimientos.py/consultatransaccion `movimientos.py` datos_transaccion /ws/movimientos.py/datos_transaccion `shake.py` ejecutar /ws/shake.py/ejecutar `shake.py` obtener /ws/shake.py/obtener `shakev2.py` ejecutar /ws/shakev2.py/ejecutar `shakev2.py` obtener /ws/shakev2.py/obtener `chat.py` chat_operator /ws/chat.py/chat_operator `chat.py` chat_user /ws/chat.py/chat_user `chat.py` prebind /ws/chat.py/prebind `util.py` logs /ws/util.py/logs `util.py` template_informes /ws/util.py/template_informes

0
docs/developer.avapframework.com/33_informe_Informe_Consejo_EN.md Normal file
View File

0
docs/developer.avapframework.com/33_informe_Informe_afiliados_con_tipo_EN.md Normal file
View File

0
docs/developer.avapframework.com/33_informe_Informe_altas_EN.md Normal file
View File

0
docs/developer.avapframework.com/33_informe_Informe_cuadro_de_mando_EN.md Normal file
View File

0
docs/developer.avapframework.com/33_informe_Informe_listado_de_usuarios_EN.md Normal file
View File

0
docs/developer.avapframework.com/33_informe_Informe_numero_altas_EN.md Normal file
View File

0
docs/developer.avapframework.com/33_informe_Informe_numero_transacciones_EN.md Normal file
View File

199
docs/developer.avapframework.com/33_informe_Informe_operaciones_EN.md Normal file
View File

@ -0,0 +1,199 @@
Report on the number of users showing the users who have registered by
themselves and those who have registered through an affiliate.
POST: {' '}
`URL_BASE + /ws/admin.py/informesadmin`
## Receives:
All the parameters that the service receives must be indicated in the body
of the request
## Returns:
Depending on the result of the operation, this service can return two
different JSON:
### Answer JSON OK:
```javascript
{
"status"
: <boolean>
,
"codtran"
: <string>
,
"resultado"
:{' '}
{
"mensaje"
: <string>
}
,
"elapsed"
: <float>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false)
* `resultado:` Service answer
* `mensaje:` Indicates the email to which the report will arrive.
* `elapsed:` Operation execution time.
### Answer JSON KO:
```javascript
{
"status"
: <boolean>
,
"nivel"
: <string>
,
"message"
: <string>
,
"error"
: <string>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `nivel:` Error importance level.
* `message:` Error message.
* `error:` Sole error code.
## Example requests:
### Python - Requests:
```javascript
import requests
url ={' '}
"URL_BASE/ws/admin.py/informesadmin"
payload ={' '}
{
'codigo_pais'
:{' '}
'MX'
,
'id_usuario'
:{' '}
'4532'
,
'id_sesion'
:{' '}
'406-dwr5sTs_m29rnbzw9_miJQ=='
,
'informe'
:{' '}
'informeconsejo'
}
files ={' '}
[
]
headers={' '}
{
}
response = requests
.request
(
"POST"
, url
, headers
=headers
, data{' '}
= payload
, files{' '}
= files
)
print
(response
.text
.encode
(
'utf8'
)
)
```
### NodeJs - Request:
```javascript
var request = require('request');
var options = {
'method': 'POST',
'url': 'URL_BASE/ws/admin.py/informesadmin',
'headers': {},
formData: {
'codigo_pais': 'MX',
'id_usuario': '4532',
'id_sesion': '406-dwr5sTs_m29rnbzw9_miJQ==',
'informe': 'informeconsejo'
}
};
request(options, function (error, response) {{' '}
if (error) throw new Error(error);
console.log(response.body);
});
```
### JavaScript - Fetch:
```javascript
var formdata = new FormData();
formdata.append("codigo_pais", "MX");
formdata.append("id_usuario", "4532");
formdata.append("id_sesion",
"406-dwr5sTs_m29rnbzw9_miJQ==");
formdata.append("informe", "informeconsejo");
var requestOptions = {
method: 'POST',
body: formdata,
redirect: 'follow'
};
fetch("URL_BASE/ws/admin.py/informesadmin",
requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
```
### CURL:
```javascript
curl --location --request POST{' '}
'URL_BASE/ws/admin.py/informesadmin'
{' '}
\
--form
'codigo_pais=MX'
{' '}
\
--form
'id_usuario=4532'
{' '}
\
--form{' '}
'id_sesion=406-dwr5sTs_m29rnbzw9_miJQ=='
{' '}
\
--form{' '}
'informe=informeconsejo'
```
## Business logic:
In order to run this service, it is necessary to do it from a user logged
into the system who has an administrator profile. With this endpoint the
requested report is generated and sent to the email of the administrator
user who requests it.

0
docs/developer.avapframework.com/33_informe_Informe_transacciones_EN.md Normal file
View File

0
docs/developer.avapframework.com/34_Ingresar_Ingresar_Prepago_EN.md Normal file
View File

0
docs/developer.avapframework.com/34_Ingresar_Ingreso_de_fondos_para_tiempo_aire_EN.md Normal file
View File

0
docs/developer.avapframework.com/35_inter_inter_networks_movement.md Normal file
View File

0
docs/developer.avapframework.com/35_inter_inter_networks_pool_stake.md Normal file
View File

0
docs/developer.avapframework.com/35_inter_interfaz_servicios_pagos_EN.md Normal file
View File

344
docs/developer.avapframework.com/36_last_last_order_summary.md Normal file
View File

@ -0,0 +1,344 @@
## ws/orders.py/last_order_summary
### Receives
All the parameters that the service receives must be indicated in the body
of the request.
## Returns:
Depending on the result of the operation, this service can return two
different JSON:
```javascript
{
"status"
:{' '}
true
,
"codtran"
:{' '}
"f856c5db007fcaa5a00b9a4d56a9d40a"
,
"resultado"
:{' '}
[
'status': 'Being sent'
,
'status_code':{' '}
4001
,
'transaction_code':{' '}
'a556a5de007fcaa5a00b4a4d56a9d40a'
,
'order_code':{' '}
10023
,
'date':{' '}
2021
-03
-01
,
'client_address': 'Street
without number',
'establishment_coordinates'
:{' '}
{
'lat':{' '}
40
,
5431311
,
'lng':{' '}
-3
,
6302845
}
,
'location_gps':{' '}
{
'lat':{' '}
40
,
5431311
,
'lng':{' '}
-3
,
6302845
}
'delivery_time': '
12
:
03
:
01'
,
'delivery_type':{' '}
'delivery',
'order_products_codes'
:
{' '}
[
{
"article_id"
:
35003
,
"custom"
:
[
[
{' '}
"da9922e8-57a6-4440-97db-0de2a486b323"
,
{' '}
"00e9a2cc-60c8-4e98-ac9b-accf15b7373a"
,
{' '}
"a6aacb94-8fad-4394-a2f1-e328fcca9c79"
]
,
[
{' '}
"757ccbe3-d877-485d-ae10-89f0b78c133c"
]
]
}
]
,
'purchase_detail': 'Palo
Alto ( Lechuga , Tomate{' '}
, Cebolla{' '}
, Aguacate{' '}
, )'
,
'order_category_id':{' '}
'FL013',
'contact':{' '}
{
"firstName"
:
"Rafa"
,
"lastName"
:
" "
,
"mail"
:
"rafa.ruiz@waynnovate.com"
,
"phone"
:
"643340526"
}
,
'status_history':{' '}
[
{
'new_status':'Being sent'
,
'new_status_code':{' '}
4001
,
'previous_status': 'Being
picked up',
'previous_status_code':
4000
,
'status_change_date': '
2021
-02
-01{' '}
13
:
00.01'{' '}
}
]
'delivery_price':{' '}
1.9
,
'delivery_distance':{' '}
34000.34)
,
]
"elapsed"
:{' '}
0.06796097755432129
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `codtran:` Operation result.
* `result:` Data of the last order in course. `status:` Status of the order. `status_code` : Code of the actual status of the order. `transaction_code` : Code of the transaction `order_code:` Code of the order. `date:` Date of the order. `client_address:` Address of the client. `establishment_coordinates` : Coordinates of the establishment that gives the order. `location_gps:` Coordinates of the direction that receives the delivery. `delivery_time:` Hour of the delivery. `delivery_type:` Type of delivery (to pickup/ to have sent). `order_products_codes:` List of product codes and their options. `purchase_detail:` List of the names of the products with their options. `order_category_id:` Identifier of the establishment that provides the product. `contact:` Contact of the client. `status_history:` History of the status changes in the order. `new_status:` New status. `new_status_code:` Code of the new status. `previous_status:` Previous status. `previous_status_code:` Previous status code. `status_change_date:` Time and date of the change of status. `delivery_price:` Price of the delivery. `delivery_distance:` Distance between the client and the establishment that provides the order.
* `status:` Status of the order.
* `status_code` : Code of the actual status of the order.
* `transaction_code` : Code of the transaction
* `order_code:` Code of the order.
* `date:` Date of the order.
* `client_address:` Address of the client.
* `establishment_coordinates` : Coordinates of the establishment that gives the order.
* `location_gps:` Coordinates of the direction that receives the delivery.
* `delivery_time:` Hour of the delivery.
* `delivery_type:` Type of delivery (to pickup/ to have sent).
* `order_products_codes:` List of product codes and their options.
* `purchase_detail:` List of the names of the products with their options.
* `order_category_id:` Identifier of the establishment that provides the product.
* `contact:` Contact of the client.
* `status_history:` History of the status changes in the order. `new_status:` New status. `new_status_code:` Code of the new status. `previous_status:` Previous status. `previous_status_code:` Previous status code. `status_change_date:` Time and date of the change of status.
* `new_status:` New status.
* `new_status_code:` Code of the new status.
* `previous_status:` Previous status.
* `previous_status_code:` Previous status code.
* `status_change_date:` Time and date of the change of status.
* `delivery_price:` Price of the delivery.
* `delivery_distance:` Distance between the client and the establishment that provides the order.
* `elapsed:` Operation execution time.
### Answer JSON KO:
```javascript
{
"status"
:{' '}
false
,
"level"
: <string>
,
"message"
: <string>
,
"error"
: <string>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `level:` Error importance level.
* `message:` Error message.
* `error:` Sole error code.
## Example requests:
### Python - Requests:
```javascript
import requests
url ={' '}
"http://34.121.95.179:80/ws/orders.py/last_order_summary?country_code=ES&user_id=133&session_id=1689-oocyMaFovWi1jljrF-eaSw=="
payload=
{
}
headers ={' '}
{
'101ObexApiKey'
:{' '}
'MS1phGJRa3WyLilN9dlZ7vurJDIpe0nM'
}
response = requests
.request
(
"GET"
, url
, headers
=headers
, data
=payload
)
print
(response
.text
)
```
### NodeJs - Request:
```javascript
var request = require('request');
var options = {
'method': 'GET',
'url':
'http://34.121.95.179:80/ws/orders.py/last_order_summary?country_code=ES&user_id=133&session_id=1689-oocyMaFovWi1jljrF-eaSw==',
'headers': {
'101ObexApiKey': 'MS1phGJRa3WyLilN9dlZ7vurJDIpe0nM'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
### JavaScript - Fetch:
```javascript
var myHeaders = new Headers();
myHeaders.append("101ObexApiKey",
"MS1phGJRa3WyLilN9dlZ7vurJDIpe0nM");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("http://34.121.95.179:80/ws/orders.py/last_order_summary?country_code=ES&user_id=133&session_id=1689-oocyMaFovWi1jljrF-eaSw==",
requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
```
### CURL:
```javascript
curl --location --request GET{' '}
'http://34.121.95.179:80/ws/orders.py/last_order_summary?country_code=ES&user_id=133&session_id=1689-oocyMaFovWi1jljrF-eaSw=='
{' '}
\
--header{' '}
'101ObexApiKey: MS1phGJRa3WyLilN9dlZ7vurJDIpe0nM'
```
## Business logic:
The objective of this service is to retrieve the orders that are in course
and its details.

0
docs/developer.avapframework.com/37_Leer_Leer_notificaciones_del_usuario_EN.md Normal file
View File

0
docs/developer.avapframework.com/37_Leer_Leer_una_notificacion_del_usuario_EN.md Normal file
View File

0
docs/developer.avapframework.com/38_liquidacion_Liquidaciones_de_Afiliados_EN.md Normal file
View File

1
docs/developer.avapframework.com/39_lista_Lista general de servicios sin catalogar_EN.md Normal file
View File

@ -0,0 +1 @@
* General list: FILE PROCEDURE URL NOTE middleware.py comprobar_disponibilidad /ws/middleware.py/comprobar_disponibilidad I assume not middleware.py datos_cuenta /ws/middleware.py/datos_cuenta I assume not middleware.py enviar_sms /ws/middleware.py/enviar_sms I assume not middleware.py firmar_santander /ws/middleware.py/firmar_santander I assume not middleware.py transaccion_contrapartida /ws/middleware.py/transaccion_contrapartida I assume not middleware.py transaccion_entre_paises /ws/middleware.py/transaccion_entre_paises I assume not util.py saldo_quiubas /ws/util.py/saldo_quiubas I assume not pawn.py carvaloration /ws/pawn.py/carvaloration KO pawn.py cml2 /ws/pawn.py/cml2 KO pawn.py get_catalog /ws/pawn.py/get_catalog KO pawn.py manager /ws/pawn.py/manager KO pawn.py notify /ws/pawn.py/notify KO pawn.py pam /ws/pawn.py/pam KO pawn.py request /ws/pawn.py/request KO pawn.py status /ws/pawn.py/status KO

0
docs/developer.avapframework.com/39_lista_Listado_de_comisiones_de_afiliado_EN.md Normal file
View File

215
docs/developer.avapframework.com/39_lista_Listado_de_divisas_EN.md Normal file
View File

@ -0,0 +1,215 @@
This service is used to obtain the currencies of the countries active in
the system.
GET:
`URL_BASE + /ws/currencies.py/listado`
## Receives:
All parameters are sent in the querystring of the call, so a percentage
encoding for URI must be applied (aka URL encoding).
## Returns:
Depending on the result of the operation, this service can return two
different JSON:
### Answer JSON OK:
```javascript
{
"status"
:{' '}
true
,
"currencies"
:{' '}
[
{
"change_sale"
: <float>
,
"currency_data"
:{' '}
{
"abbreviation"
: <string>
,
"suffix"
: <string>
,
"format"
: <string>
,
"symbol"
: <string>
,
"prefix"
: <string>
,
"decimals"
: <decimal>
,
"id"
: <integer>
}
,
"abbreviation"
: <string>
,
"format"
: <string>
,
"currency_symbol"
: <string>
,
"precision"
: <integer>
,
"change_purchase"
: <float>
,
"change_reference"
: <float>
,
"name"
: <string>
,
"placeholder_currency"
: <string>
}
]
,
"elapsed"
:{' '}
0.008363962173461914
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `currencies:` List of currencies returned by the system.
* `currency_data:` Contains the different details of the currency used for the operation..
* `abbreviation:` The abbreviated name of the currency(EUR, MXN).
* `suffix:` Indicates the suffix that is applied in the currency format(pesos, euros).
* `format:` The full format that applies to the currency, it includes the suffix and the prefix.
* `symbol:` The symbol associated to the currency(€, ¢, $).
* `prefix:` The prefix that is applied in the currency format.
* `decimals:` The maximum number of decimal places that will be included in the currency format.
* `id:` Identifier of the currency in BBDD.
* `abbreviation:` The abbreviated name of the currency(EUR, MXN).
* `format:` The full format that applies to the currency, it includes the suffix and the prefix.
* `name:` Full name of the currency.
* `precision:` Number of decimal places allowed by the currency.
* `currency_symbol:` The symbol associated to the currency (€, ¢, $).
* `placeholder_currency:` The text of the currency always showing a value of 0.
* `change_purchase:` Currency price for purchase.
* `change_reference:` The value of the currency.
* `change_sale:` Currency price for sale.
* `elapsed:` Operation execution time.
### Answer JSON KO:
```javascript
{
"status"
:{' '}
false
,
"level"
: <string>
,
"message"
: <string>
,
"error"
: <string>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `level:` Error importance level.
* `message:` Error message.
* `error:` Sole error code.
## Example requests:
### Python - Requests:
```javascript
import requests
url ={' '}
"URL_BASE/ws/currencies.py/listado"
payload ={' '}
{
}
headers={' '}
{
}
response = requests
.request
(
"GET"
, url
, headers
=headers
, data{' '}
= payload
)
print
(response
.text
.encode
(
'utf8'
)
)
```
### NodeJs - Request:
```javascript
var request = require('request');
var options = {
'method': 'GET',
'url': 'URL_BASE/ws/currencies.py/listado',
'headers': {}
};
request(options, function (error, response) {{' '}
if (error) throw new Error(error);
console.log(response.body);
});
```
### JavaScript - Fetch:
```javascript
var requestOptions = {
method: 'GET',
redirect: 'follow'
};
fetch("URL_BASE/ws/currencies.py/listado",
requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
```
### CURL:
```javascript
curl --location --request GET{' '}
'URL_BASE/ws/currencies.py/listado'
```
## Business logic
This service, through the 'telefone', searches for the user whose
movements are to be consulted, and returns a list with each of the
user's movements between two given dates.

0
docs/developer.avapframework.com/39_lista_Listado_de_movimientos_EN.md Normal file
View File

165
docs/developer.avapframework.com/39_lista_Listado_de_movimientos_granemisor_EN.md Normal file
View File

@ -0,0 +1,165 @@
This service is used to obtain the movements made by a large issuer user
within the system.
GET: {' '}
`URL_BASE + /ws/granemisor.py/listado`
## Receives:
All parameters are sent in the querystring of the call, so a percentage
encoding for URI must be applied (aka URL encoding).
## Returns:
Depending on the result of the operation, this service can return two
different JSON:
### Answer JSON OK:
```javascript
{
"status"
:{' '}
true
,
"datos"
:{' '}
[
[ <string>{' '}
]
]
,
"numero_resultados"
: <integer>
,
"totales"
: <integer>
,
"columnas"
:{' '}
[<string>
]
,
"limite_resultados"
: <integer>
,
"elapsed"
: <float>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `datos:` they are a list of lists in which each one contains the values for each of the columns.
* `elapsed:` Operation execution time.
* `numero_resultados:` Number of results that come in 'datos'
* `totales:` Total number of results
* `columnas:` Name of each of the values found in each of the lists in the data list..
* `limite_resultados:` Maximum number of results that come in the query.
### Answer JSON KO:
```javascript
{
"status"
:{' '}
false
,
"nivel"
: <string>
,
"message"
: <string>
,
"error"
: <string>
}
```
## Where:
* `status:` Shows if the call has been successful (true) or not (false).
* `nivel:` Error importance level.
* `message:` Error message.
* `error:` Sole error code.
## Example requests:
### Python - Requests:
```javascript
import requests
url ={' '}
"URL_BASE/ws/granemisor.py/listado?codigo_pais=MX&id_usuario=2&id_sesion=387-M301Sm9r7MK6QXs27Z_XHw==&num_movimientos=2&fechainicio=1-04-2010&fechafin=29-07-2020"
payload ={' '}
{
}
headers={' '}
{
}
response = requests
.request
(
"GET"
, url
, headers
=headers
, data{' '}
= payload
)
print
(response
.text
.encode
(
'utf8'
)
)
```
### NodeJs - Request:
```javascript
var request = require('request');
var options = {
'method': 'GET',
'url':
'URL_BASE/ws/granemisor.py/listado?codigo_pais=MX&id_usuario=2&id_sesion=387-M301Sm9r7MK6QXs27Z_XHw==&num_movimientos=2&fechainicio=1-04-2010&fechafin=29-07-2020',
'headers': {}
};
request(options, function (error, response) {{' '}
if (error) throw new Error(error);
console.log(response.body);
});
```
### JavaScript - Fetch:
```javascript
var requestOptions = {
method: 'GET',
redirect: 'follow'
};
{' '}
fetch("URL_BASE/ws/granemisor.py/listado?codigo_pais=MX&id_usuario=2&id_sesion=387-M301Sm9r7MK6QXs27Z_XHw==&num_movimientos=2&fechainicio=1-04-2010&fechafin=29-07-2020",
requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
```
### CURL:
```javascript
curl --location --request GET{' '}
'URL_BASE/ws/granemisor.py/listado?codigo_pais=MX&id_usuario=2&id_sesion=387-M301Sm9r7MK6QXs27Z_XHw==&num_movimientos=2&fechainicio=1-04-2010&fechafin=29-07-2020'
```
## Business logic:
This service returns a list with each of the movements of the large issuer
user between two given dates.

0
docs/developer.avapframework.com/39_lista_Listado_de_solicitudes_KYC_EN.md Normal file
View File

0
docs/developer.avapframework.com/39_lista_Listado_de_usuarios_bloqueados_EN.md Normal file
View File

0
docs/developer.avapframework.com/39_lista_Listado_de_usuarios_en_lista_negra_EN.md Normal file
View File

0
docs/developer.avapframework.com/39_lista_Listar_Programa_de_Puntos_EN.md Normal file
View File

0
docs/developer.avapframework.com/39_lista_Listar_Soluciones_EN.md Normal file
View File

0
docs/developer.avapframework.com/39_lista_Listar_Usuarios_del_Programa_de_Puntos_EN.md Normal file
View File

25
docs/developer.avapframework.com/3_Currencies_And_Fx_Exchange.md Normal file
View File

@ -0,0 +1,25 @@
This document presents all the AVAP extensions for Microsoft Visual Studio Code, which will enable developers to manage every phase and process involved in the development and publication of APIs as part of their lifecycle within the AVAP Framework.
### Installation of Extensions
It is recommended to install the extensions from the Microsoft Visual Studio Code marketplace, although you can also download them manually from the AVAP ID portal and install them in your IDE.
### Available Extensions
* AVAP Linter & Completion Purpose: Provides knowledge of AVAP (Advanced Virtual API Programming) format and syntax within the Microsoft IDE. Features: Syntax highlighting, code suggestions, and error correction.
* AVAP Main Purpose: Base extension that includes Organization, Projects, and Teams components. Features: Management of organizations, creation and administration of projects, and configuration of development teams.
* AVAP API Publisher Purpose: Assists developers in the entire API publishing process across the different environments in their deployment. Features: Publication of APIs in Local, Test, and Live environments with configuration and control options.
* AVAP API Version Control Purpose: A complete version control manager for API development using AVAP coding. Features: Version control, change tracking, and API version management.
* AVAP Connectors Purpose: Provides a fast and secure mechanism for connecting to databases and external systems. Features: Configuration and management of connections to databases and external systems.
### Prerequisites
Before starting to work with the extensions, it is important to understand the credential and identification system known as AVAP ID. All users need to be registered at AVAP ID and have an active account, as well as a developer token to activate the AVAP extensions in Microsoft Visual Studio Code.
### Activation and Use of Extensions
Once the developer has their developer token, they can install the extensions from the marketplace. The extensions will automatically activate and appear in the left-hand side or extension bar of Visual Studio Code.
With AVAP extensions for Microsoft Visual Studio Code, developers can carry out the full lifecycle of an API, from development to testing, publication, and administration.
For more information, check out AVAP Alexandria at alexandria.avapframework.com and join the user community at AVAP Communities.

0
docs/developer.avapframework.com/3_Envio_de_dinero_EN_Envio_de_dinero_EN.md Normal file
View File

0
docs/developer.avapframework.com/3_get_blockchain_networks_get_blockchain_networks.md Normal file
View File

0
docs/developer.avapframework.com/40_logout_Logout_Services_EN.md Normal file
View File

0
docs/developer.avapframework.com/40_logout_Logs_del_sistema_EN.md Normal file
View File

29
docs/developer.avapframework.com/41_loyalty_Loyalty_Points_Exchange_EN.md Normal file
View File

@ -0,0 +1,29 @@
In your project, you can work with loyalty wallets to which you can assign
a FIAT currency, a non-FIAT currency or a new currency created by you, to
which you give a purchase and sale values. This is referred to as a
personalized wallet by default.
As a concept, a personalized or loyalty wallet accumulates balance or
points that can later be exchanged for products, but that in no case can
be transformed into liquid money regardless of whether it is the result of
an ATM withdrawal, bank account, purchase of prepaid cards, or any other
concept that facilitates cashing out from a loyalty wallet.
Transfers between users are not allowed unless the destination or wallet
of the beneficiary of the transfer is a wallet of the same type with the
same limitations and the configuration of the wallet allows such
transfers.
Personalized or loyalty wallets rely on the currency table of the FX
Exchange service to carry out the operations of buying and selling
products from loyalty wallets, thus allowing customers to buy any type of
product, if they meet the conditions to be acquired by a source of
loyalty-type funds regardless of the type of currency held by the product
to be purchased.
In this way, a customer with a loyalty wallet in USD can purchase products
published in EUR or MXN without any problem. Just like a customer with a
loyalty wallet in My_Coin, can purchase the same products mentioned above.
It is in the configuration of the FX Exchange currency table where the
purchase and sale price of My_Coin is determined, with USD serving as the
reference.

Some files were not shown because too many files have changed in this diff Show More