README_old.md

Ejemplos NodeJs

Entorno

Base	Nombre	Versión	Referencia
Lenguaje / Entorno	NodeJs	10.15.3 LTS	https://nodejs.org/
Package Manager	npm	6.4.1	https://www.npmjs.com/
Librería HTTP Request	request	2.88.0	https://www.npmjs.com/package/request

Estructura de las Peticiones

Todas las peticiones se construyen de la siguiente forma:

Elemento
URL	El URL base para todos los recursos es https://sync.paybook.com/v1/
Autenticación	Usuarios y Sesiones: Authorization: api_key api_key={API_KEY}, id_user={ID_USER} Otros Recursos: Authorization: TOKEN token={TOKEN}
Método	POST	GET	PUT	DELETE
Media Type	Content-Type: application/json	-	-	-
Parámetros	Payload Body	Query String	Query String	Query String

curl URL \
-H AUTH \
-X METHOD \
-H MEDIA_TYPE \
-d PARAMS \

Ejemplos

Recurso	Acción	Script	Options
Usuario	Creación	examples/user/create.js	--api_key
	Listar	examples/user/get.js	--api_key
	Actualización	examples/user/update.js	--api_key --id_user
	Eliminar	examples/user/delete.js	--api_key --id_user
Session	Creación	examples/session/create.js	--api_key --id_user
	Validación	examples/session/verify.js	--token
	Eliminar	examples/session/delete.js	--token
Catalogo	Listar Sitios agrupados por Organización	examples/catalogues/get_organizations_sites.js	--token --is_test
Credenciales	Creación	Widget Se recomienda hacer uso del Widget para cubrir éste caso de uso, ya que considera los escenarios listados a continuación: Credenciales con Token Credenciales sin autenticación de dos factores Credenciales con Captcha (ó QRCode) Credenciales con Selección Múltiples de Imágenes Credenciales con Selección Múltiple de Texto
		examples/create_credentials.js Simula los Escenarios de Twofa	--token --id_site --credentials
	Obtener Credenciales	examples/credential/get.js	--token
	Actualizar Credencial	examples/credential/update.js	--token --id_credential
	Eliminar Credencial	examples/credential/delete.js	--token --id_credential
Cuenta	Listado	examples/get_accounts.js	--token --id_credential
Transacción	Listado	examples/get_transactions.js	--token --id_credential --id_account
Archivo Adjunto	Listado	examples/get_attachments.js Obtener el listado de archivos adjuntos disponibles para descarga	--token --id_credential --id_account
	Descarga	examples/download_attachments.js Descargar un archivo adjunto seleccionado	--token --id_attachment

Pruebas

IMPORTANTE. Ya sea que las pruebas se realicen con una máquina virtual o no, te recomiendo ampliamente que bajo ninguna circunstancia almacenes el API KEY en un archivo de texto plano, en los ejemplos mostrados se accede al API KEY mediante la lectura de Variables de Entorno, y te aconsejo que definas ésta variable cada que comiences una sesión de trabajo.

Si tienes instalado Docker, puedes probar los scripts de la siguiente manera:

Instalación de dependencias

docker run \
--name sync-node \
-it \
--rm \
-v "$PWD":/usr/src/app \
-w /usr/src/app \
node:10.15.3-alpine npm install

Ejecución de scripts

docker run \
--name sync-node \
-it \
--rm \
-v "$PWD":/usr/src/app \
-w /usr/src/app \
node:10.15.3-alpine node examples/{resource}/{action}.js [options]