Integration Test - Developer Wizard
We have launched a guided integration feature: Integration Check, which can help you speed up your integration. Please log in to the GTR website, which can be found on the My Account > Integration Check menu.
Before executing this Wizard, you must at least apply for an API Key on the GTR website, which is in My Account > API Info > API Key.
Regarding the API Key Token, we separate the production and integration test api endpoints, the Login Session will not be shared. This means that you need to use our integration test api endpoint to login first, and the Production Token cannot be shared.
The following list helps you understand what is different from the production configuration:
Configuration Name | Production Environment | Integration Check Environment |
---|---|---|
Callback URL | Not shared, configured separately. | Not shared, configured separately. |
Public Key | Not shared, configured separately. | Not shared, configured separately. |
API Key (mTLS Cert) | Shared | Shared |
API Key (Secret Token and Access Token) | Shared | Shared |
IP Whitelist | Shared, maximum count total is 5. | Shared, maximum count total is 5. |
Login Token | Not shared, configured separately. | Not shared, configured separately. |
API Endpoint | Not shared, configured separately. Path started from: https://platform.globaltravelrule.com/ | Not shared, configured separately. Path started from: https://platform.globaltravelrule.com/integration_check |
As we mentioned in section 1, you must login first, and save the token into a local file [we save to shared_passphrase.txt as example]. And each api invoke will dump the file as a token to the Authorization Header.
Before starting the test, we recommend that you treat the following profile as a user in your service and add it to your service database, this is convenient when you are doing integration testing with a user directly on your system.
Simulated Natural Person
- Address: 1GURHee2JsCkdpxVisjbjAeNhbDbGub8R4
- Ticker: USDT
- Network: ERC20
- FirstName: Nakamoto
- LastName: Satoshi
- Date Of Birth: 1986-11-21
- TX ID: 1fcd10006f252d2cca3a4803d0dcb84b0ee10ef73d1055f0fe23ce4ead0f6e75t
Legal Person
- Address: 0x1b9609Fc5de83E36e53C1b9952B66e691b057DE1
- Ticker: USDT
- Network: ERC20
- Company Name: Simulation Business Company Inc.
- TX ID: 357a7b33eb604f5af901c1d4d62f9bc3018b355e885ba609bfca5e6a0a82694f
Common Functions:
Basic Check (Production)
Goal: Check all settings have been done.
Prerequisite:
- Set your public key on My Account > Settings > Public Key.
- Set your callback url on My Account > Settings > Callback URL.
Check IP Whitelist Working (Test Environment)
Goal: Check your testing/dev network is able to access GTR service.
Prerequisites:
- Submit your IP Whitelist request on My Account > Settings > IP Whitelist.
- Set your public key on the Integration Check page.
- Simply send the HTTPS (with client certificate) request to GTR.
Check Callback Network Working (Test Environment)
Goal: Check your testing/dev callback server is able to receive the request from GTR.
Prerequisites:
- (Optional) Set GTR’s Outbound IP to your whitelist (35.74.112.84, 43.206.88.63, and 3.114.14.124)
- Build a HTTPS server, and set the callback url in the Integration Check page.
Check IP Whitelist Working (Production Environment)
Goal: Check your production network is able to access GTR service.
Prerequisites:
- Submit your IP Whitelist Request on My Account > Settings > IP Whitelist.
- Submit your public key for production.
- Let your production server send the HTTPS (with client certificate) request to GTR.
Check Callback Network (Production Environment)
Goal: Check your production callback server is able to receive the request from GTR.
Prerequisites:
- (Optional) Set GTR’s Outbound IP to your whitelist (35.74.112.84, 43.206.88.63, and 3.114.14.124)
- Submit your server callback url My Account > Settings > Callback URL.
- Build a HTTPS server, accept IP Whitelist from GTR and correctly respond to it.
Before On Chain Test Functions (For Originator):
Submit Before On Chain
Goal: Check that you have the ability to make requests as an Originator
Prerequisites: Make a before on chain request.
Update Transaction ID After On Blockchain
Goal: Check you are responsible for updating the transaction ID on the chain after each transaction is completed.
Prerequisites: Make an update tx id request.
Before On Chain Test Functions (For Beneficiary):
Normal Address Exists Check
Goal: Check you as the Beneficiary will verify that the address exists.
Prerequisites: Develop to handle receiving callbackType:6 and check address and return success
Normal PII Receive Verify Check
Goal: Check that you as a Beneficiary will receive PII and verify the information.
Prerequisites: Develop to handle receiving callbackType: 4 and verify the PII and return success.
Normal Transaction ID Receive Check
Goal: Check that you, as a Beneficiary, will receive the on-chain Transaction ID from Originator
Prerequisites: Develop to handle receiving callbackType: 7 and return success. (means that you received)
Address Not Exists Check
Goal: Checking your counterexample as a Beneficiary will check if the address does not exist.
Prerequisites: We will send you the non-existent address, make sure you really check the address in your service, and we expect you to return as status code: 200001.