Skip to content

Commit 43766c0

Browse files
authored
Merge pull request #120 from maxmind/fatih/sandbox-info
Add info on the Sandbox env
2 parents f5fbc7a + c432afe commit 43766c0

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

README.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@ constructors take your MaxMind account ID and license key:
4444
>>> client = Client(42, 'licensekey')
4545
>>> async_client = AsyncClient(42, 'licensekey')
4646
47+
To use the Sandbox web service instead of the production web service,
48+
you can provide the host argument:
49+
50+
.. code-block:: pycon
51+
52+
>>> client = Client(42, 'licensekey', 'sandbox.maxmind.com')
53+
>>> async_client = AsyncClient(42, 'licensekey', 'sandbox.maxmind.com')
54+
4755
Score, Insights and Factors Usage
4856
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4957

minfraud/webservice.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,11 @@ def __init__(
455455
:param license_key: Your MaxMind license key
456456
:type license_key: str
457457
:param host: The host to use when connecting to the web service.
458+
By default, the client connects to the production host. However,
459+
during testing and development, you can set this option to
460+
'sandbox.maxmind.com' to use the Sandbox environment's host. The
461+
sandbox allows you to experiment with the API without affecting your
462+
production data.
458463
:type host: str
459464
:param locales: A tuple of locale codes to use in name property
460465
:type locales: tuple[str]

0 commit comments

Comments
 (0)