Skip to content

Latest commit

 

History

History
82 lines (54 loc) · 2.1 KB

README.md

File metadata and controls

82 lines (54 loc) · 2.1 KB
Raw

🌟 Community-Powered Repository 🌟

This repository is crafted with ❤️ by our talented community members. It's a space for everyone to use, contribute to, and share. While it aligns with the spirit of our community, please note that this repo is not directly endorsed or supported by Investec. Always exercise caution and discretion when using or contributing to community-driven projects.

InvestecOpenApi Client

Gem Version

A simple client wrapper for the Investec Open API.

Features:

  • Authorize access via OAuth
  • Retrieve accounts
  • Retrieve transactions per account

Installation

Add this line to your application's Gemfile:

gem 'investec_open_api'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install investec_open_api

Create a new initializer called investec_open_api.rb in config/initializers:

InvestecOpenApi.configuration do |config|
    config.api_key       = ENV['API_KEY']
    config.client_id     = ENV['CLIENT_ID']
    config.client_secret = ENV['CLIENT_SECRET']
end

Create a new file in the root of your directory called .env and place the following:

API_KEY='YOUR API KEY'
CLIENT_ID='YOUR CLIENT ID'
CLIENT_SECRET='YOUR CLIENT SECRET'

You will need to register to get the following credentials. Follow the steps in Enrolment in the documentation.

Usage

To use the wrapper, create an instance of InvestecOpenApi::Client and then authenticate with your credentials:

client = InvestecOpenApi::Client.new
client.authenticate!

Once authenticated you can retrieve your accounts:

accounts = client.accounts
my_account = accounts.first

Use the ID of one of your accounts to retrieve transactions:

client.transactions(my_account.id)

License

The gem is available as open source under the terms of the MIT License.