README.md in tikkie-api-0.1.0 vs README.md in tikkie-api-0.1.1
- old
+ new
@@ -1,7 +1,11 @@
# Tikkie API
+[![Gem Version](https://badge.fury.io/rb/tikkie-api.svg)](https://badge.fury.io/rb/tikkie-api)
+[![Build Status](https://travis-ci.org/KentaaNL/tikkie-api.svg?branch=master)](https://travis-ci.org/KentaaNL/tikkie-api)
+[![Code Climate](https://codeclimate.com/github/KentaaNL/tikkie-api/badges/gpa.svg)](https://codeclimate.com/github/KentaaNL/tikkie-api)
+
Unofficial Ruby library for communicating with the [Tikkie API](https://developer.abnamro.com/content/tikkie).
## Installation
Add this line to your application's Gemfile:
@@ -31,10 +35,16 @@
config = Tikkie::Api::Configuration.new("your_api_key", "private_rsa.pem")
client = Tikkie::Api::Client.new(config)
```
+The configuration is created for the production environment by default. If you want to use the sandbox testing environment, then add the option `test: true` when creating the configuration:
+
+```ruby
+config = Tikkie::Api::Configuration.new("your_api_key", "private_rsa.pem", test: true)
+```
+
### Platforms
Retrieve all platforms:
```ruby
@@ -112,10 +122,10 @@
description: "Test",
external_id: "Invoice 12345" # optional
)
tikkie_url = payment_request.payment_request_url
-payment_request_token =payment_request.payment_request_token
+payment_request_token = payment_request.payment_request_token
```
### Error handling
All responses to an API request include the methods `success?` and `error?` to determine whether the API call was successful or not. When the API request was not successful, the method `errors` will return details about the error response.