Download the PHP package paybook/sync-php without Composer

On this page you can find all versions of the php package paybook/sync-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of paybook/sync-php

Informations about the package sync-php

![Sync-Paybook-logo][logo]

SYNC-PHP

Sync recupera información de las cuentas y sus transacciones, de instituciones financieras autorizados por el usuario, y lo regresa a soluciones de terceros en un formato organizado, muy fácil de utilizar.

Tabla de contenidos

Instalación

  1. Instalar mediante composer

Requerimientos

  1. API Key:

    Cuando creamos una cuenta de Paybook Sync se nos proporcionó una API Key, por ejemplo:

    Al crear tu cuenta se te proporcionan dos API Keys: Producción & Sandbox. Las cuales tienen el mismo proposito, ambas nos permiten implementar Paybook Sync, pero Sandbox nos permite hacerlo sin la necesidad de tener credenciales reales de bancos o el SAT.

    Este API key lo podemos visualizar como la contraseña o llave de acceso a los servicios de Paybook Sync. Solamente a través de ella podremos empezar a interactuar con las instituciones que sincronicemos.

    Nota: Pasar de una API key a otra es tan sensillo como escribir la nueva API key correspondiente.

2.Webhook

Opcional pero altamente recomendable para lograr una integración completa de las funcionalidades de Paybook Sync.

Modelo de información

El modelo de información de Paybook Sync es bastante sencillo. Prácticamente podemos visualizar al API key como el elemento raíz del modelo, del cual se desglosan los usuarios, pero entendamos como usuarios a aquellas entidades (personas o empresas) a las cuales se les desea sincronizar las instituciones financieras que el servicio de Paybook Sync facilita, podemos apreciarlo gráficamente en este diagrama:

sync-model-image

Hay que mencionar la diferencia entre un usuario de Paybook Sync (usted, el developer) y un usuario del API key: Por cada usuario de Paybook Sync, hay un API key y cada API key puede tener N usuarios.

Users (Usuarios)

Los usuarios son segmentaciones lógicas para los usuarios finales. Una mejor práctica es registrar usuarios para tener su información agrupada y control en ambos extremos.

Catalogs/Sites (Catálogos)

Los catálogos son colecciones de endpoints que son importantes para la clasificación de otros endpoints. Dentro de estos se encuentran los sitios que nos permite consultar los sitios financieros disponibles para sincronizar a través de Paybook Sync.

Credentials (Credenciales)

Las credenciales se refieren a la información de terceras personas que se necesita para autorizar el acceso a un sitio de terceros. Las credenciales se encriptan al momento de introducirse y no están disponibles en ningún endpoint. La información que se extrae de este endpoint, será sólo complementaria.

Es necesario tener al menos un usuario registrado para crear credenciales.

Accounts (Cuentas)

Las cuentas son repositorios de transacciones de usuarios finales, que normalmente se clasifican por alguna característica como tipo y/o número de cuenta. La cuenta y la información de las transacciones pueden recuperarse desde sitios de terceros y se actualizan hasta una vez al día.

Transactions (Transacciones)

Las transacciones son los movimientos financieros que están relacionados con una cuenta, y reflejan el ingreso o egreso que el usuario final tiene en determinado sitio. La cantidad de información histórica que Sync puede recuperar, varía dependiendo de la fuente pero, por lo general, estarán disponibles las transacciones de 60 días.

Attachments (Archivos Adjuntos)

Los archivos adjuntos son archivos que están relacionados con las cuentas o las transacciones. La disponibilidad y el tipo de archivo adjunto varía de acuerdo a la fuente.

En Resumen:

A partir de los usuarios podemos crear credenciales, las cuales son únicas por cada usuario e institución. Una vez creada una credencial automáticamente se crea una cuenta correspondiente, esto permite manejar fácilmente diferentes cuentas de un mismo usuario de una misma institución.

Por último pero no menos importante, se encuentran las transacciones que dependen de su respectiva cuenta, algunas transacciones vienen con un documento el cual llamaremos Attachments o mejor dicho “documentos adjuntos”, los cuales son el último recurso en el modelo de de información de Paybook Sync.

Implementación

La librería

Incluye la librería y declara tu API Key.

¡Importante!: No escribas tu API KEY directamente en tu código o en texto plano, ya que es una mala práctica de seguridad.

La librería incluye los métodos:

Y hace uso los siguientes métodos de HTTP:

Metodo Acción
GET Consultar
POST Crear
PUT Actualizar
DELETE Eliminar

Dependiendo del recurso y la acción a realizar, será el método de la librería, el método de HTTP y el elemento de autenticación (se explica en la sección de autenticación) a usar.

Puedes ver más acerca de cada uno en recursos y ejemplos.

Implementación de un Webhook

Un Webhook es una devolución de llamada HTTP a un URL especificado. Ellos se activan cada vez que se actualizan los datos de sincronización para ayudarte a mantenerte al día con los últimos cambios en la información.

La ventaja principal es que te permite recibir las últimas actualizaciones de credenciales, transacciones y attachments directamente en tu aplicación sin necesidad de estar preguntando constantemente por ellas.

alt

Para fines prácticos de desarrollo usaremos el servicio de ngrok, el cual nos permite crear URLs públicas para exponer nuestro servidor local a través de internet. Puedes consultar cómo instalarlo en su página de descargas.

Ahora crearemos un servidor sencillo con PHP y Slim.

Cabe mencionar que se hace uso de estas tecnologías con fines ilustrativos y el desarrollador es libre de implementar las que crea más convenientes.

Creando un archivo al que llamaremos server.php e incluiremos el siguiente código:

Habiendo terminado lo anterior, instalamos slim con el comando composer require slim/slim slim/psr7 y luego corremos nuestro servidor con el comando php -S server.php

Warning: The built-in web server was designed to aid application development. It may also be useful for testing purposes or for application demonstrations that are run in controlled environments. It is not intended to be a full-featured web server. It should not be used on a public network.

Por último ejecutamos ngrok con el comando: <path-to>/ngrok http 3000 y tendremos nuestro servidor listo escuchando por actualizaciones del webhook.

La URL que nos proporcione ngrok es la misma que tendrás que mandar cuando creas un webhook como en este ejemplo.

Nota: ngrok solo debe ser usado durante el desarrollo y no se recomienda usarlo de esta forma en producción.

Sync Widget

El widget de Sync se puede usar para crear, actualizar y activar la sincronización de credenciales de forma sencilla con pocas líneas de código desde tu Front-end. Visita el repositorio oficial para implementarlo, ampliamente recomendado.

La ventaja principal es que te brinda una poderosa interfaz que te permite ahorrar pasos en la implementación.

Autenticación

En el API de Paybook Sync hay dos elementos de autenticación: API KEY & TOKEN.

Por razones de seguridad se recomienda ampliamente utilizar el Token ya que así limitas el acceso de información solamente al usuario correspondiente.

Todas las peticiones al API de Paybook Sync deben ir autenticadas, dependerá del recurso con el que se va a operar la llave de autenticación a utilizar.

Recurso Auth
Usuarios API KEY
Webhooks API KEY
Catalogs Token
Credentials Token
Accounts Token
Transactions Token
Attachments Token

Obtener un Token de sesión:

Respuesta:

Puedes ver más acerca de cada uno en recursos y ejemplos.

Flujo de Información

En este apartado veremos un ejemplo del flujo ideal para obtener la información desde el API de Paybook Sync, aunque las posibilidades son muchas, este es el caso ideal para hacernos con la información.

data-flow-img

Para este punto, si decidiste hacer uso del Sync Widget, te habrás ahorrado los pasos 2, 3 y 4.

Los pasos en el diagrama son los siguientes:

  1. Crea un usuario. (ver ejemplo)
  2. Consulta los sitios y selecciona el sitio que deseas sincronizar. (ver ejemplo)
  3. Crea una credencial para ese usuario y sitio. (ver ejemplo)
  4. Monitorea el estatus de la nueva credencial. (ver ejemplo)
  5. Crea un webhook nuevo, indica un Endpoint en tu aplicación donde esperas las actualizaciones). (ver ejemplo)
  6. Espera y procesa las actualizaciones que recibas de Sync.
  7. Consulta la nueva información disponible en el recurso respectivo.

Recursos y Ejemplos

Puedes consultar más información acerca de los parametros de cada recurso en la documentación oficial de paybook.

Usuarios

Recurso Acción Método Autenticación Parametros
/users Consulta usuarios para esa API Key GET
Crea un usuario nuevo POST
/users/:id_user Actualiza un usuario PUT
Elimina un usuario DELETE {}

Consultar usuarios

Devuelve:

Consultar un usuario en especifico

Devuelve:

Crear un Usuario

Devuelve:

Actualizar un Usuario

Devuelve:

Eliminar un usuario

Nota: Esto eliminará toda la información del usuario.

Devuelve:

Catálogos

Recurso Acción Método Autenticación Parametros
/catalogues/account_types Consultar los tipos de cuentas GET
/catalogues/attachment_types Consulta los tipos de archivos adjuntos
/catalogues/countries Consulta los países disponibles
/catalogues/sites Consulta los sitios disponiles
/catalogues/site_organizations Consulta las organizaciones del sitio
/catalogues/organizations/sites Consulta los sitios agrupados por organización del sitio

Catálogos de Instituciones

Paybook Sync proporciona un catálogo de las instituciones que podemos sincronizar para los usuarios.

Devuelve:

Credenciales

Recurso Acción Método Autenticación Parametros
/credentials Consulta credenciales registradas GET
Crea o actualiza credenciales POST
/credentials/:id_credential Elimina un usuario DELETE
/jobs/:id_job/status Consulta historial de cambios hechos a estas credenciales (últimos 15 días) GET

Puedes consultar más acerca de los códigos de respuesta y su significado aquí.

Cada institución tiene sus propias credenciales, algunas instituciones requieren un paso de seguridad "Two factor authentication" o "TWOFA"; Los siguientes ejemplos cubren ambos casos.

Credenciales normales

Normal: Credenciales que sólo requieren user y password.

  1. Crear credenciales normal

Devuelve:

  1. Monitoreo del estado de la credencial

Devuelve:

Credenciales TWOFA

  1. Consulta el sitio Twofa del catálogo
  2. Crea las credencials
  3. Consulta el status de las credenciales y valida que sea TWOFA
  4. Manda el TWOFA
  5. Consulta nuevamente el status

Consultar credenciales

Devuelve:

Eliminar una credencial

Devuelve:

Consultar historial de cambios de la credencial

Devuelve:

Puedes consultar el significado de cada código aquí.

Cuentas

Recurso Acción Método Autenticación Parametros
/accounts Consulta las cuentas de un usuario específico GET

Consulta las cuentas de un usuario específico

Devuelve:

Transacciones

Recurso Acción Método Autenticación Parametros
/transactions Consulta las transacciones de un usuario específico GET
/transactions/count Consulta el número de transacciones dados algunos parámetros de búsqueda GET

Consulta las transacciones de un usuario específico

Devuelve:

Consulta el número de transacciones dados algunos parámetros de búsqueda

Devuelve:

Webhooks

Recurso Acción Método Autenticación Parametros
/webhooks Consulta los webhooks creados GET
Crear o actualizar un webhhook POST
Eliminar un webhhook DELETE

Crear Webhook

Devuelve:

Consultar Webhooks

Devuelve:

Eliminar Webhook

Devuelve:

Archivos adjuntos (Attachments)

Recurso Acción Método Autenticación Parametros
/attachments Consulta los archivos adjuntos de un usuario específico GET
/attachments/count Consultar el número de archivos adjuntos
/attachments/:id_attachment Regresa el archivo adjunto
/attachments/:id_attachment/extra Regresa la información extraída del archivo adjunto

Consulta los archivos adjuntos de un usuario específico

Devuelve:

Regresa el archivo adjunto

Devuelve:

Regresa la información extraída del archivo adjunto

Devuelve:

Entorno

Versions used by the time this file was writted

Enlaces de interes

  1. Documentación oficial de Paybook Sync.
  2. Parametros para cada recurso.
  3. Códigos de respuesta y su significado.
  4. Consumiendo el API REST de Sync vía Postman paso a paso. Ampliamente recomendado para entender la estructura de una cuenta de Paybook Sync.

Comentarios y aportes

¡Sientete con la confianza de hacer un pull request! :ok_hand:

_Made with :blueheart: by Paybook family.

All versions of sync-php with dependencies

PHP Build Version
Package Version
Requires rmccue/requests Version ^1.7
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package paybook/sync-php contains the following files

Loading the files please wait ....