Paybook iOS Library V1.2.0

Esta es la librería de Paybook para iOS. Mediante esta librería usted puede implementar el API REST de Paybook de manera rapida y sencilla a través de sus clases y métodos.

Requerimientos

1. Xcode 7.3+
2. Gestor de dependencias CocoaPods ($ gem install cocoapods)

Instalación

Para integrar Paybook en tu proyecto Xcode usando CocoaPods, lo primero que tenemos que hacer es instalar la libreria de Paybook, para eso nos dirigiremos al directorio de mi proyecto por medio de la terminal, estando ahí ejecutaremos el siguiente comando para crear nuestro pod file:

$ pod init

*Importante: * La ejecución del comando anterior requiere que tengas instalado cocoapods en tu equipo.

El siguiente paso es editar nuestro pod file para agregar nuestras dependencias, utiliza el siguiente comando para abrir tu pod file en Xcode:

$ open -a Xcode Podfile

Reemplaza el contenido de tu pod file con el siguiente codigo:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!

target 'YOUR_PROJECT_NAME' do
use_frameworks!
pod 'Paybook', '~> 1.2.0'
end

Importante: Para tener soporte con las diferentes versiones de Swift verifique que version de Paybook devera agregar en su Pod File:

• Swift 2.2- -> Paybook 1.1.1
• Swift 2.3 -> Paybook 1.2.0

Quickstart:

Antes de consultar la documentación puedes tomar alguno de nuestros tutoriales:

• Quickstart para sincronizar al SAT

• Quickstart para sincronizar una cuenta bancaria con credenciales sencillas (usuario y contraseña)

• Quickstart para sincronizar una cuenta bancaria con token (usuario y contraseña)

Recordatorios:

• Puedes consultar la documentación del API REST aquí
• Puedes consultar todos los recursos que tenemos para ti aquí

Documentación:

Cada método está documentado tomando como base la siguiente estructura:

method_type returned_value_type x = class_or_instance.get(attr1:attr1_type,...,attrn:attrN_type)

1. method_type: indica si el método es estático, en caso de no estar indica que el método es de instancia, o bien, es un constructor.
2. returned_value_type: indica el tipo de dato regresado por el método
3. x: es una representación del valor retornado por el método
4. class_or_instance: es la Clase o una instancia de la clase que contiene el método a ejecutar
5. attrX: es el nombre del atributo X
6. attrX_type: es el tipo de dato del atributo X

Importante: Todos los metodos necesitan un medio de auntentificación ya sea por medio del id_user o una session y regresan valores por medio de una función completionHandler que recibe el tipo de dato a retornar en caso de que el request sea exitoso o un error en caso de fallar e.g:

Account.get([mySession], id_user: nil, completionHandler: {
    response, error in
    print("\(response), \(error)")
})

Accounts

Estructura de los atributos de la clase:

Descripción de los métodos de la clase:

Attachments

Estructura de los atributos de la clase:

Descripción de los métodos de la clase:

Catalogues

Estructuras de la clase:

Descripción de los métodos de la clase:

Credentials

Estructura de los atributos de la clase:

Descripción de los métodos de la clase:

Sessions

Estructura de los atributos de la clase:

Descripción de los métodos de la clase:

Transactions

Estructura de los atributos de la clase:

Descripción de los métodos de la clase:

User

Estructura de los atributos de la clase:

Descripción de los métodos de la clase: