Project

flinks

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
flinksphildionne/flinksHomepageDocumentationSource CodeBug TrackerWiki
Flinks financial services API client
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
16,098
Stars
1
Forks
3
Watchers
3
 Releases
Current version
0.5.2
Total releases
9
First release
2018-02-05
Latest release
2018-07-03
 Issues
Open Issues
1
Closed Issues
1
Total Issues
2
Issue Closure Rate
50%
 Pull Requests
Open Pull Requests
4
Closed Pull Requests
1
Merged Pull Requests
0
Pull Request Acceptance Rate
0%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2018-10-25
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.0
juwelier
~> 2.1.0
rdoc
~> 3.12
rspec
>= 0
shoulda
>= 0
simplecov
>= 0
webmock
>= 0

Runtime

activesupport
>= 3.0
dry-initializer
~> 2.4
dry-validation
~> 0.11
http
~> 3.0
 Project Readme

Flinks

A ruby client for the Flinks API.

Maintainability Test Coverage Build Status

Installation

gem install flinks

Or with bundler:

gem 'flinks', require: 'flinks'

Usage

This library needs to be configured with your API customer ID.

flinks = Flinks.new(customer_id: ENV['FLINKS_CUSTOMER_ID'])

Configure on_error to catch API requests returning a 400..599 HTTP status.

flinks = Flinks.new({
  customer_id: ENV['FLINKS_CUSTOMER_ID'],
  on_error: Proc.new do |status, message, body|
    p [status, message, body]
  end
})

Configure debug to print every API requests and responses. Default to false.

flinks = Flinks.new({
  customer_id: ENV['FLINKS_CUSTOMER_ID'],
  debug: true
})

Configure raw to get the raw, non-transformed API response. Default to false.

flinks = Flinks.new({
  customer_id: ENV['FLINKS_CUSTOMER_ID'],
  raw: true
})

Sandbox and Production

By default, the client uses the sandbox API endpoint: https://toolbox-api.private.fin.ag/v3. In production, the API endpoint must be configured with your own:

flinks = Flinks.new(customer_id: ENV['FLINKS_CUSTOMER_ID'], api_endpoint: "https://YOURNAME-api.private.fin.ag/v3")

Endpoints

Authorize

  • authorize(login_id:, options:)
  • authorize_with_credentials(username:, password:, institution:, options:)
  • authorize_multiple(login_ids:)

Account

  • accounts_summary(request_id:, options:)
  • accounts_summary_async(request_id:)
  • accounts_detail(request_id:, options:)
  • accounts_detail_async(request_id:)

Card

  • delete_card(card_id:)

Refresh

  • set_scheduled_refresh(activated, login_id:)

Statement

  • statements(options:)
  • statements_async(request_id:)

Errors

Client Errors

Error Description
Flinks::ClientError Raised when API returns a 400..499 HTTP status code
Flinks::BadRequest Raised when API returns a 400 HTTP status code
Flinks::Unauthorized Raised when API returns a 401 HTTP status code
Flinks::Forbidden Raised when API returns a 403 HTTP status code
Flinks::TooManyRequests Raised when API returns a 403 HTTP status code for rate limit exceeded
Flinks::NotFound Raised when API returns a 404 HTTP status code
Flinks::MethodNotAllowed Raised when API returns a 405 HTTP status code
Flinks::NotAcceptable Raised when API returns a 406 HTTP status code
Flinks::Conflict Raised when API returns a 409 HTTP status code
Flinks::UnsupportedMediaType Raised when API returns a 415 HTTP status code
Flinks::UnprocessableEntity Raised when API returns a 422 HTTP status code

Server Errors

Error Description
Flinks::ServerError Raised when API returns a 500..599 HTTP status code
Flinks::InternalServerError Raised when API returns a 500 HTTP status code
Flinks::NotImplemented Raised when API returns a 501 HTTP status code
Flinks::BadGateway Raised when API returns a 502 HTTP status code
Flinks::ServiceUnavailable Raised when API returns a 503 HTTP status code

Documentation

See the API docs.

Supported Ruby versions

  • MRI 2.3
  • MRI 2.4
  • MRI 2.5

Development

Run all tests:

bundle exec rspec

License

MIT