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.
- Xcode 7.3+
- Gestor de dependencias CocoaPods ($ gem install cocoapods)
Para integrar PaybookSync en tu proyecto Xcode usando CocoaPods, solo especifica en tu Podfile:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
target '<Your Target Name>' do
pod 'PaybookSync', '~> 1.0.2'
end
Luego, ejecuta el siguiente comando:
$ pod install
**Importante: ** Es importante asegurarse de tener instalado anteriormente CocoaPods.
Antes de consultar la documentación puedes tomar alguno de nuestros tutoriales:
-
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)
- Puedes consultar la documentación del API REST aquí
- Puedes consultar todos los recursos que tenemos para ti aquí
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)
- 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.
- returned_value_type: indica el tipo de dato regresado por el método
- x: es una representación del valor retornado por el método
- class_or_instance: es la Clase o una instancia de la clase que contiene el método a ejecutar
- attrX: es el nombre del atributo X
- attrX_type: es el tipo de dato del atributo X
Importante: Todos los metodos 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)")
})
Estructura de los atributos de la clase:
Account |
---|
+ str id_account + str id_external + str id_user + str id_credential + str id_site + str id_site_organization + str name + str number + float balance + str site + str dt_refresh |
Descripción de los métodos de la clase:
Action | REST API ENDPOINT | LIBRARY METHOD |
---|---|---|
Requests accounts of a user | GET https://sync.paybook.com/v1/accounts | static NSArray [Account] = Account.get(session:Session,id_user:String?,completionHandler:(([Account]?, NSError?)->())?) |
Estructura de los atributos de la clase:
Attachments |
---|
+ str id_account + str id_external + str id_user + str id_attachment_type + str id_transaction + str file + str extra + str url + str dt_refresh |
Descripción de los métodos de la clase:
Action | REST API ENDPOINT | LIBRARY METHOD |
---|---|---|
Requests attachments | GET https://sync.paybook.com/v1/attachments GET https://sync.paybook.com/v1/attachments/:id_attachment GET https://sync.paybook.com/v1/attachments/:id_attachment/extra |
static list [Attachment] = Attachment.get(session=Session,id_user=str,id_attachment=str,extra=bool) |
Request the number of attachments | GET https://sync.paybook.com/v1/attachments/counts | static int attachments_count = Attachment.get_count(session=Session,id_user=str) |
Estructuras de la clase:
Account_type | Attachment_type | Country |
---|---|---|
+ str id_account_type + str name |
+ str id_attachment_type + str name |
+ str id_country + str name + str code |
Site | Credential_structure | Site_organization |
---|---|---|
+ str id_site + str id_site_organization + str id_site_organization_type + str name + list credentials |
+ str name + str type + str label + bool required + str username |
+ str id_site_organization + str id_site_organization_type + str id_country + str name + str avatar + str small_cover + str cover |
Descripción de los métodos de la clase:
Action | REST API ENDPOINT | LIBRARY METHOD |
---|---|---|
Request account types | GET https://sync.paybook.com/v1/catalogues/account_types | static NSArray [Account_type] = Catalogues.get_account_types(session:Session,id_user:String?,completionHandler:(([Account_type]?, NSError?)->())?) |
Request attachment types | GET https://sync.paybook.com/v1/catalogues/attachment_types | static NSArray [Attachment_type] = Catalogues.get_attachment_types(session:Session,id_user:String?,completionHandler:(([Attachment_type]?,NSError?)->())?) |
Request available countries | GET https://sync.paybook.com/v1/catalogues/countries | static NSArray [Country] = Catalogues.get_countries(session:Session,id_user:String?,completionHandler:(([Country]?,NSError?)->())?) |
Request available sites | GET https://sync.paybook.com/v1/catalogues/sites | static NSArray [Site] = Catalogues.get_sites(session:Session,id_user:String?,completionHandler:(([Site]?,NSError?)->())?) |
Request site organizations | GET https://sync.paybook.com/v1/catalogues/site_organizations | static NSArray [Site_organization] = Catalogues.get_site_organizations(session:Session,id_user:String?,completionHandler:(([Site_organization]?,NSError?)->())?) |
Estructura de los atributos de la clase:
Credentials |
---|
+ str id_site + str id_credential + str username + str id_site_organization + str id_site_organization_type + str ws + str status + str twofa |
Descripción de los métodos de la clase:
Action | REST API ENDPOINT | LIBRARY METHOD |
---|---|---|
Creates or updates credentials | POST https://sync.paybook.com/v1/credentials | Credentials credentials = Credential(session:Session,id_user:String?,id_site:String,credentials:NSDictionary,completionHandler:((Credentials?,NSError?)->())?) |
Deletes credentials | DELETE https://sync.paybook.com/v1/credentials/:id_credential | static NSDictionary deleted Credentials.delete(session:Session,id_user:String?,id_credential:String,completionHandler:((NSDictionary?,NSError?)->())?) |
Request status | GET status_url | list [Dict] = credentials.get_status(session=Session,id_user=str) |
Set twofa | POST twofa_url | bool twofa_set = credentials.set_twofa(session=Session,id_user=str,twofa_value=str) |
Request register credentials | GET https://sync.paybook.com/v1/credentials | static list [Credentials] = Credentials.get(session:Session,id_user:String?,completionHandler:(([Credentials]?,NSError?)->())?) |
Estructura de los atributos de la clase:
Sessions |
---|
+ User user + str token |
Descripción de los métodos de la clase:
Action | REST API ENDPOINT | LIBRARY METHOD |
---|---|---|
Creates a session | POST https://sync.paybook.com/v1/sessions | Session session = Session(id_user:String,completionHandler:((Session?,NSError?)->())?) |
Verify a session | GET https://sync.paybook.com/v1/sessions/:token/verify | NSDictionary verified = session.verify(completionHandler:((NSDictionary?, NSError?)->())?) |
Deletes a session | DELETE https://sync.paybook.com/v1/sessions/:token | static NSDictionary deleted = Session.delete(token:String,completionHandler:((NSDictionary?,NSError?)->())?) |
Estructura de los atributos de la clase:
Transactions |
---|
+ str id_transaction + str id_user + str id_external + str id_site + str id_site_organization + str id_site_organization_type + str id_account + str id_account_type + str is_disable + str description + float amount + str dt_transaction + str dt_refresh |
Descripción de los métodos de la clase:
Action | REST API ENDPOINT | LIBRARY METHOD |
---|---|---|
Requests number of transactions | GET https://sync.paybook.com/v1/transactions/count | static int transactions_count = Transaction.get_count(session :Session,id_user:String?,completionHandler:((Int?, NSError?)->())?) |
Requests transactions | GET https://sync.paybook.com/v1/transactions | static NSArray [Transaction] = Transaction.get(session:Session,id_user:String?,completionHandler:(([Transaction]?,NSError?)->())?) |
Estructura de los atributos de la clase:
User |
---|
+ str name + str id_user + str id_external + str dt_create + str dt_modify |
Descripción de los métodos de la clase:
Action | REST API ENDPOINT | LIBRARY METHOD |
---|---|---|
Creates a user | POST https://sync.paybook.com/v1/users | User user = User(username:String,completionHandler:((User?,NSError?)->())?) |
Deletes a user | DELETE https://sync.paybook.com/v1/users | static NSDictionary deleted = User.delete(id_user:String,completionHandler: ((NSDictionary?, NSError?)->())?) |
Get users | GET https://sync.paybook.com/v1/users | static NSArray [User] = User.get(completionHandler:(([User]?,NSError?)->())?) |