Docs / Options
Development Environment
Build and test your integration for free with test mode, which never touches your quota or your event feed.
Two ways to enter test mode#
- Use a test key. Keys that start with
gx_test_always run in test mode. - Add
mode=testto a request made with any key.
# with a test key
curl "https://gurdx.cretip.com/api/lookup/ip?ip=1.1.1.1&key=gx_test_YOUR_TEST_KEY"
# with a live key, forcing test mode for this request
curl "https://gurdx.cretip.com/api/lookup/ip?ip=1.1.1.1&key=gx_live_YOUR_KEY&mode=test"
mode accepts live (default) or test; anything else returns error 111 invalid_mode. A test key cannot be switched to live with mode=live.
What test mode does#
| Behaviour | Test mode |
|---|---|
| Counts against your quota | No, it is free |
| Raises events, webhooks or notifications | Never |
| Response shape | Identical to live |
| Data returned | Fake but well-formed |
| Contacts external services | Never |
Because the data is generated, do not use test responses to judge accuracy or to make real decisions. Use them to check that your code parses fields, handles every branch and reacts correctly to errors.
Still validated#
Test mode keeps the gate in place. A request still needs a valid key, an active account and subscription, an authorized host, access to the method through your plan, and valid options. Missing or malformed input still fails with the usual error, so you can exercise your error handling:
curl "https://gurdx.cretip.com/api/lookup/ip?ip=not-an-ip&key=gx_test_YOUR_TEST_KEY"
{
"status": "error",
"code": 112,
"type": "invalid_ip",
"description": "The IP Address is not valid or empty."
}
Recommended workflow#
- Create a test key in the dashboard (https://gurdx.cretip.com/app) and keep it in your development
.env. - Write your integration and automated tests against it.
- Switch to a
gx_live_key through configuration in production. - Keep a small smoke test using
mode=testwith the live key to verify connectivity after deployment without spending quota.
Note: The flood limit of 1,000 requests per second still applies to test calls from the same account.
See also API keys and Usage limits.
Found a mistake? Tell us on the contact page. Contact