Skip to content

Commit 6a7e08c

Browse files
authored
Merge pull request #86 from maxmind/fatih/sandbox-info
Add info on Sandbox host
2 parents f0e110e + c1a0a29 commit 6a7e08c

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,16 @@ Minfraud.configure do |c|
5050
end
5151
````
5252

53+
To use the Sandbox web service instead of the production web service, you can provide the host:
54+
55+
```ruby
56+
Minfraud.configure do |c|
57+
c.account_id = 12345
58+
c.license_key = 'your_license_key'
59+
c.host = 'sandbox.maxmind.com'
60+
end
61+
```
62+
5363
### Making a minFraud Score, Insights, or Factors Request
5464

5565
To use the minFraud API, create a `Minfraud::Assessments` object. The

lib/minfraud.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ class << self
4343
attr_accessor :enable_validation
4444

4545
# The host to use when connecting to the web service.
46+
# By default, the client connects to the production host. However,
47+
# during testing and development, you can set this option to
48+
# 'sandbox.maxmind.com' to use the Sandbox environment's host. The
49+
# sandbox allows you to experiment with the API without affecting your
50+
# production data.
4651
#
4752
# @return [String, nil]
4853
attr_accessor :host

0 commit comments

Comments
 (0)