Enviornment setup for testing the APIs
Your Access Service (Multi Member Node)
Before accessing APIs , credentials need to be created. It’s recommended to create credentials for each Logivity Service (such as Logivity Connect) and each client (UI, API Integration) - the reason for this is to achieve full resource isolation. Access Service credentials can be generated in the Logivity portal.
- TEST : https://tmaapp-test.tmaorg.io/login/signin.html
- PROD : https://portal.tma.io/login/signin.html
Parameters such as your Node URL (referred to as {node-url} in this document), your username and password can be read by clicking “Show service parameters”.
Below are some extra configuration parameters required to execute APIs (required for substitution):
| Parameter | Test environment | Prod environment |
|---|---|---|
| cc-channel | carrierconnect-test | carrierconnect |
| lb-channel | lb-test | loadboard |
Your library of Enviornment Variables
The document you are reading presents a subset of API examples, however it gives a good overview of aspects such as field descriptions and error handling scenarios.
Please refer to the “API Definition" tab for a full list of example requests,including the ones described in this document.
Below are the variable descriptions for the setting up your Enviornment:
| Environment Variable | Description |
|---|---|
| node-url | Node URL. Available in Logivity portal “Credentials” page |
| auth-username | Service User. Available in Logivity portal “Credentials” page |
| auth-password | Service Password (Secret). Available in Logivity portal “Credentials” page |
| cc-channel | Logivity Connect channel name |
| lb-channel | Logivity Loadboard channel name |
| carrier-tma-id | Carrier Logivity ID. Available in Logivity Portal |
| carrier-parma | Carrier refrence id |
| loadboard-tma-id | LoadBoard Logivity ID. |
| shipper-tma-id Shipper | Logivity ID. |
| subscription-channel | Channel used to subscribe for events (cc-channel or lb-channel) |
You need to fill in the environment variables before sending Connect and loadboard requests.