Skip to content

Commit c2db0db

Browse files
Incorporacion documentacion para las distintas versiones
1 parent 08048d1 commit c2db0db

1 file changed

Lines changed: 75 additions & 18 deletions

File tree

docs/getting-started/setup.rst

Lines changed: 75 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,106 @@
11
Configuración
22
=============
33

4-
Para utilizar el cliente de API de API Gateway, se debe tener un token de usuario, generado y obtenido desde la cuenta de API Gateway.
4+
Para utilizar el cliente de API de API Gateway, se debe tener un token de usuario generado desde la cuenta de API Gateway.
55

66
.. important::
7-
El archivo test.env sólo sirve para usar con los test. Por lo que se deberán definir las variables de entorno por los siguientes dos métodos: Directo por consola (temporal), o definirlas directamente en el entorno (persistente).
7+
El archivo ``test.env`` sólo sirve para usar con los test.
88

9-
En Linux o MacOS:
10-
-----------------
9+
Versiones de API
10+
----------------
1111

12-
El token se almacena en una variable de entorno. Para almacenar en una variable de entorno, se debe escribir lo siguiente en consola:
12+
El cliente permite utilizar dos versiones de la API mediante variables de entorno.
13+
14+
**API v1 (legacy)**
15+
16+
- URL: ``https://legacy.apigateway.cl``
17+
18+
**API v2 (recomendada)**
19+
20+
- URL: ``https://app.apigateway.cl``
21+
22+
.. note::
23+
Si no se define ``APIGATEWAY_API_VERSION`` el cliente utilizará automáticamente **v2**.
24+
25+
Variables de entorno
26+
--------------------
27+
28+
Las siguientes variables deben definirse en el sistema:
29+
30+
- ``APIGATEWAY_API_URL``
31+
- ``APIGATEWAY_API_VERSION``
32+
- ``APIGATEWAY_API_TOKEN``
33+
34+
``APIGATEWAY_API_TOKEN`` es una cadena extremadamente larga. Guárdala en un lugar seguro.
35+
36+
Linux o MacOS
37+
-------------
38+
39+
**Configuración para API v1**
1340

1441
.. code-block:: shell
42+
1543
export APIGATEWAY_API_URL="https://legacy.apigateway.cl"
44+
export APIGATEWAY_API_VERSION="v1"
1645
export APIGATEWAY_API_TOKEN="aqui-su-token-de-apigateway"
1746
18-
- ``APIGATEWAY_API_TOKEN`` es una cadena de caracteres extremadamente larga. Almacena ese token en un lugar seguro y no lo compartas con nadie.
47+
**Configuración para API v2**
48+
49+
.. code-block:: shell
50+
51+
export APIGATEWAY_API_URL="https://app.apigateway.cl"
52+
export APIGATEWAY_API_VERSION="v2"
53+
export APIGATEWAY_API_TOKEN="aqui-su-token-de-apigateway"
1954
20-
Introducir en consola las variables de entorno almacena temporalmente las variables, y alternativamente, se puede modificar el archivo de configuración de shell en Linux (que se explicará a continuación), y añadir al final del archivo los comandos previamente introducidos. Añadir variables de entorno de esta forma es más persistente y no se repite su definición.
55+
Para hacerlo persistente:
2156

22-
- Si se usa Linux, se deben añadir al archivo ``~/.bashrc`` los comandos previamente definidos.
23-
- Si se usa MacOS, se deben añadir al archivo ``~/.zshrc``.
57+
- Linux: añadir al archivo ``~/.bashrc``
58+
- MacOS: añadir al archivo ``~/.zshrc``
2459

25-
El paso siguiente sólo se hace para usuarios de MacOS. Por último, ejecutar el comando en cuestión para efectuar los cambios.
60+
Luego ejecutar:
2661

2762
.. code-block:: shell
63+
2864
source ~/.zshrc
2965
30-
En Windows:
31-
-----------
66+
Windows
67+
-------
3268

33-
Para almacenar en una variable de entorno en Windows, hay varias alternativas. La primera es utilizando cmd, y para almacenarlas utilizando cmd, ejecuta en el buscador de Windows "cmd", y ejecuta los siguientes comandos:
69+
**CMD – API v1**
3470

3571
.. code-block:: shell
72+
3673
setx APIGATEWAY_API_URL "https://legacy.apigateway.cl"
74+
setx APIGATEWAY_API_VERSION "v1"
75+
setx APIGATEWAY_API_TOKEN "aqui-su-token-de-apigateway"
76+
77+
**CMD – API v2**
78+
79+
.. code-block:: shell
80+
81+
setx APIGATEWAY_API_URL "https://app.apigateway.cl"
82+
setx APIGATEWAY_API_VERSION "v2"
3783
setx APIGATEWAY_API_TOKEN "aqui-su-token-de-apigateway"
3884
39-
También se pueden definir utilizando Windows PowerShell, de una manera similar. Ejecuta en el buscador de Windows "PowerShell", y ejecuta los siguientes comandos:
85+
**PowerShell – API v1**
4086

4187
.. code-block:: shell
88+
4289
$Env:APIGATEWAY_API_URL = "https://legacy.apigateway.cl"
90+
$Env:APIGATEWAY_API_VERSION = "v1"
4391
$Env:APIGATEWAY_API_TOKEN = "aqui-su-token-de-apigateway"
4492
45-
Como alternativa para almacenar las variables de manera persistente, debes seguir los siguientes pasos:
93+
**PowerShell – API v2**
94+
95+
.. code-block:: shell
96+
97+
$Env:APIGATEWAY_API_URL = "https://app.apigateway.cl"
98+
$Env:APIGATEWAY_API_VERSION = "v2"
99+
$Env:APIGATEWAY_API_TOKEN = "aqui-su-token-de-apigateway"
100+
101+
.. important::
102+
Como alternativa para almacenar las variables de manera persistente, debes seguir los siguientes pasos:
46103

47-
1. Abre el Panel de Control > Sistema > Configuración avanzada del sistema.
48-
2. En la pestaña Opciones avanzadas, selecciona Variables de entorno.
49-
3. Añade o modifica las variables en la sección de "Variables de usuario" o "Variables del sistema".
104+
1. Abre el Panel de Control > Sistema > Configuración avanzada del sistema.
105+
2. En la pestaña Opciones avanzadas, selecciona Variables de entorno.
106+
3. Añade o modifica las variables en la sección de "Variables de usuario" o "Variables del sistema".

0 commit comments

Comments
 (0)