API Gateway: Cliente de API en Python
=====================================
.. image:: https://badge.fury.io/py/apigatewaycl.svg
:target: https://pypi.org/project/apigatewaycl
.. image:: https://img.shields.io/pypi/status/apigatewaycl.svg
:target: https://pypi.org/project/apigatewaycl
.. image:: https://img.shields.io/pypi/pyversions/apigatewaycl.svg
:target: https://pypi.org/project/apigatewaycl
.. image:: https://img.shields.io/pypi/l/apigatewaycl.svg
:target: https://raw.githubusercontent.com/apigatewaycl/apigateway-api-client-python/master/COPYING
Cliente para realizar la integración con los servicios web de `API Gateway <https://www.apigateway.cl>`_ desde Python.
Instalación y actualización
---------------------------
Instalar usando un entorno virtual y PIP con:
.. code:: shell
python3 -m venv venv
source venv/bin/activate
pip install apigatewaycl
Actualizar usando PIP con:
.. code:: shell
pip install apigatewaycl --upgrade
Cliente genérico vs clientes específicos
----------------------------------------
Este cliente de API Gateway tiene 2 formas de acceder a los recursos de la API:
1. Cliente genérico: es un cliente que permite consumir de manera sencilla cualquier
recurso de la API. Que actualmente exista o sea añadido en el futuro. Esto se logra
porque el cliente recibe los nombres de los recursos, la parte de la URL que permite
acceder al servicio web solicitado. Se proveen métodos que sólo sirven para acceder
a la API de manera genérica, pero no para hacer acciones específicas ni obtener los
datos en un formato específico. Este cliente es el que entrega mayor flexibilidad, ya
que cada programador decide qué recursos desea consumir y cómo desea obtener los datos.
2. Clientes específicos: son clases que permiten acceder de forma más natural a los
recursos de la API. Al instanciar la clase, se tendrán métodos sencillos con parámetros
para consumir la API. Sin ser necesario preocuparse de recordar o buscar en la
documentación el nombre de los recursos que se deben consumir. Además de entregar los
datos ya "listos" para ser usados en vez de tener que preocuparse de qué método del
cliente genérico usar para obtenerlos en el formato requerido.
Autenticación en API Gateway
----------------------------
Lo más simple, y recomendado, es usar una variable de entorno con el
`token del usuario <https://apigateway.cl/dashboard#api-auth>`_, la cual será
reconocida automáticamente por el cliente:
.. code:: shell
export APIGATEWAY_API_TOKEN="aquí-tu-token-de-usuario"
Si no se desea usar una variable de entorno, al instanciar los objetos se
deberá indicar el token del usuario. Ejemplo con el cliente genérico:
.. code:: python
import apigatewaycl
APIGATEWAY_API_TOKEN = "aquí-tu-token-de-usuario"
client = apigatewaycl.api_client.ApiClient(APIGATEWAY_API_TOKEN)
El siguiente es un ejemplo con el cliente específico de Rcv. Primero se pasan
los datos obligatorios de RUT y clave del usuario. Luego además se pasa el token
delusuario de la API.
.. code:: python
import apigatewaycl
APIGATEWAY_API_TOKEN = "aquí-tu-token-de-usuario"
SII_USUARIO_RUT = ""
SII_USUARIO_CLAVE = ""
rcv_client = Rcv(SII_USUARIO_RUT, SII_USUARIO_CLAVE, api_token = APIGATEWAY_API_TOKEN)
Si se usan variables de entorno, en ambos ejemplos se puede omitir el argumento `api_token`.
Licencia
--------
Este programa es software libre: usted puede redistribuirlo y/o modificarlo
bajo los términos de la GNU Lesser General Public License (LGPL) publicada
por la Fundación para el Software Libre, ya sea la versión 3 de la Licencia,
o (a su elección) cualquier versión posterior de la misma.
Este programa se distribuye con la esperanza de que sea útil, pero SIN
GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la GNU Lesser General
Public License (LGPL) para obtener una información más detallada.
Debería haber recibido una copia de la GNU Lesser General Public License
(LGPL) junto a este programa. En caso contrario, consulte
`GNU Lesser General Public License <http://www.gnu.org/licenses/lgpl.html>`_.
Enlaces
-------
- `Sitio web API Gateway <https://www.apigateway.cl>`_.
- `Código fuente en GitHub <https://github.com/apigatewaycl/apigateway-api-client-python>`_.
- `Paquete en PyPI <https://pypi.org/project/apigatewaycl>`_.
- `Documentación en Read the Docs <https://apigatewaycl.readthedocs.io/es/latest>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/apigatewaycl/apigateway-api-client-python",
"name": "apigatewaycl",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sii chile",
"author": "API Gateway",
"author_email": "dev@apigateway.cl",
"download_url": "https://files.pythonhosted.org/packages/81/fb/e8e3a4682426a338801bc9873a5c74c6e487f992a4520009baeaa95f0e3a/apigatewaycl-3.1.3.tar.gz",
"platform": null,
"description": "\nAPI Gateway: Cliente de API en Python\n=====================================\n\n.. image:: https://badge.fury.io/py/apigatewaycl.svg\n :target: https://pypi.org/project/apigatewaycl\n.. image:: https://img.shields.io/pypi/status/apigatewaycl.svg\n :target: https://pypi.org/project/apigatewaycl\n.. image:: https://img.shields.io/pypi/pyversions/apigatewaycl.svg\n :target: https://pypi.org/project/apigatewaycl\n.. image:: https://img.shields.io/pypi/l/apigatewaycl.svg\n :target: https://raw.githubusercontent.com/apigatewaycl/apigateway-api-client-python/master/COPYING\n\nCliente para realizar la integraci\u00f3n con los servicios web de `API Gateway <https://www.apigateway.cl>`_ desde Python.\n\nInstalaci\u00f3n y actualizaci\u00f3n\n---------------------------\n\nInstalar usando un entorno virtual y PIP con:\n\n.. code:: shell\n\n python3 -m venv venv\n source venv/bin/activate\n pip install apigatewaycl\n\nActualizar usando PIP con:\n\n.. code:: shell\n\n pip install apigatewaycl --upgrade\n\nCliente gen\u00e9rico vs clientes espec\u00edficos\n----------------------------------------\n\nEste cliente de API Gateway tiene 2 formas de acceder a los recursos de la API:\n\n1. Cliente gen\u00e9rico: es un cliente que permite consumir de manera sencilla cualquier\n recurso de la API. Que actualmente exista o sea a\u00f1adido en el futuro. Esto se logra\n porque el cliente recibe los nombres de los recursos, la parte de la URL que permite\n acceder al servicio web solicitado. Se proveen m\u00e9todos que s\u00f3lo sirven para acceder\n a la API de manera gen\u00e9rica, pero no para hacer acciones espec\u00edficas ni obtener los\n datos en un formato espec\u00edfico. Este cliente es el que entrega mayor flexibilidad, ya\n que cada programador decide qu\u00e9 recursos desea consumir y c\u00f3mo desea obtener los datos.\n\n2. Clientes espec\u00edficos: son clases que permiten acceder de forma m\u00e1s natural a los\n recursos de la API. Al instanciar la clase, se tendr\u00e1n m\u00e9todos sencillos con par\u00e1metros\n para consumir la API. Sin ser necesario preocuparse de recordar o buscar en la\n documentaci\u00f3n el nombre de los recursos que se deben consumir. Adem\u00e1s de entregar los\n datos ya \"listos\" para ser usados en vez de tener que preocuparse de qu\u00e9 m\u00e9todo del\n cliente gen\u00e9rico usar para obtenerlos en el formato requerido.\n\nAutenticaci\u00f3n en API Gateway\n----------------------------\n\nLo m\u00e1s simple, y recomendado, es usar una variable de entorno con el\n`token del usuario <https://apigateway.cl/dashboard#api-auth>`_, la cual ser\u00e1\nreconocida autom\u00e1ticamente por el cliente:\n\n.. code:: shell\n\n export APIGATEWAY_API_TOKEN=\"aqu\u00ed-tu-token-de-usuario\"\n\nSi no se desea usar una variable de entorno, al instanciar los objetos se\ndeber\u00e1 indicar el token del usuario. Ejemplo con el cliente gen\u00e9rico:\n\n.. code:: python\n\n import apigatewaycl\n APIGATEWAY_API_TOKEN = \"aqu\u00ed-tu-token-de-usuario\"\n client = apigatewaycl.api_client.ApiClient(APIGATEWAY_API_TOKEN)\n\nEl siguiente es un ejemplo con el cliente espec\u00edfico de Rcv. Primero se pasan\nlos datos obligatorios de RUT y clave del usuario. Luego adem\u00e1s se pasa el token\ndelusuario de la API.\n\n.. code:: python\n\n import apigatewaycl\n APIGATEWAY_API_TOKEN = \"aqu\u00ed-tu-token-de-usuario\"\n SII_USUARIO_RUT = \"\"\n SII_USUARIO_CLAVE = \"\"\n rcv_client = Rcv(SII_USUARIO_RUT, SII_USUARIO_CLAVE, api_token = APIGATEWAY_API_TOKEN)\n\nSi se usan variables de entorno, en ambos ejemplos se puede omitir el argumento `api_token`.\n\nLicencia\n--------\n\nEste programa es software libre: usted puede redistribuirlo y/o modificarlo\nbajo los t\u00e9rminos de la GNU Lesser General Public License (LGPL) publicada\npor la Fundaci\u00f3n para el Software Libre, ya sea la versi\u00f3n 3 de la Licencia,\no (a su elecci\u00f3n) cualquier versi\u00f3n posterior de la misma.\n\nEste programa se distribuye con la esperanza de que sea \u00fatil, pero SIN\nGARANT\u00cdA ALGUNA; ni siquiera la garant\u00eda impl\u00edcita MERCANTIL o de APTITUD\nPARA UN PROP\u00d3SITO DETERMINADO. Consulte los detalles de la GNU Lesser General\nPublic License (LGPL) para obtener una informaci\u00f3n m\u00e1s detallada.\n\nDeber\u00eda haber recibido una copia de la GNU Lesser General Public License\n(LGPL) junto a este programa. En caso contrario, consulte\n`GNU Lesser General Public License <http://www.gnu.org/licenses/lgpl.html>`_.\n\nEnlaces\n-------\n\n- `Sitio web API Gateway <https://www.apigateway.cl>`_.\n- `C\u00f3digo fuente en GitHub <https://github.com/apigatewaycl/apigateway-api-client-python>`_.\n- `Paquete en PyPI <https://pypi.org/project/apigatewaycl>`_.\n- `Documentaci\u00f3n en Read the Docs <https://apigatewaycl.readthedocs.io/es/latest>`_.\n",
"bugtrack_url": null,
"license": "LGPL",
"summary": "Cliente para realizar la integraci\u00f3n con los servicios web de API Gateway desde Python.",
"version": "3.1.3",
"project_urls": {
"Homepage": "https://github.com/apigatewaycl/apigateway-api-client-python"
},
"split_keywords": [
"sii",
"chile"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81fbe8e3a4682426a338801bc9873a5c74c6e487f992a4520009baeaa95f0e3a",
"md5": "16ef50861768b1892d90db7ea7ab44c0",
"sha256": "ac998d4c6a80b668705ecd2c4dee9c22e2e474f179bad80dc40c9aedb02d3987"
},
"downloads": -1,
"filename": "apigatewaycl-3.1.3.tar.gz",
"has_sig": false,
"md5_digest": "16ef50861768b1892d90db7ea7ab44c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15846,
"upload_time": "2024-02-14T18:46:54",
"upload_time_iso_8601": "2024-02-14T18:46:54.544337Z",
"url": "https://files.pythonhosted.org/packages/81/fb/e8e3a4682426a338801bc9873a5c74c6e487f992a4520009baeaa95f0e3a/apigatewaycl-3.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 18:46:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apigatewaycl",
"github_project": "apigateway-api-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "alabaster",
"specs": [
[
"==",
"0.7.15"
]
]
},
{
"name": "Babel",
"specs": [
[
"==",
"2.14.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2023.11.17"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.20.1"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.6"
]
]
},
{
"name": "imagesize",
"specs": [
[
"==",
"1.4.1"
]
]
},
{
"name": "importlib-metadata",
"specs": [
[
"==",
"7.0.1"
]
]
},
{
"name": "install",
"specs": [
[
"==",
"1.3.5"
]
]
},
{
"name": "jaraco.classes",
"specs": [
[
"==",
"3.3.0"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"==",
"3.1.2"
]
]
},
{
"name": "keyring",
"specs": [
[
"==",
"24.3.0"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "MarkupSafe",
"specs": [
[
"==",
"2.1.3"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "more-itertools",
"specs": [
[
"==",
"10.2.0"
]
]
},
{
"name": "nh3",
"specs": [
[
"==",
"0.2.15"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"23.2"
]
]
},
{
"name": "pkginfo",
"specs": [
[
"==",
"1.9.6"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.17.2"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "readme-renderer",
"specs": [
[
"==",
"42.0"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "rfc3986",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.7.0"
]
]
},
{
"name": "snowballstemmer",
"specs": [
[
"==",
"2.2.0"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"==",
"7.2.6"
]
]
},
{
"name": "sphinx-rtd-theme",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "sphinxcontrib-applehelp",
"specs": [
[
"==",
"1.0.7"
]
]
},
{
"name": "sphinxcontrib-devhelp",
"specs": [
[
"==",
"1.0.5"
]
]
},
{
"name": "sphinxcontrib-htmlhelp",
"specs": [
[
"==",
"2.0.4"
]
]
},
{
"name": "sphinxcontrib-jquery",
"specs": [
[
"==",
"4.1"
]
]
},
{
"name": "sphinxcontrib-jsmath",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "sphinxcontrib-qthelp",
"specs": [
[
"==",
"1.0.6"
]
]
},
{
"name": "sphinxcontrib-serializinghtml",
"specs": [
[
"==",
"1.1.9"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"4.0.2"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "zipp",
"specs": [
[
"==",
"3.17.0"
]
]
}
],
"lcname": "apigatewaycl"
}
JSON
