{"info":{"_postman_id":"4939fed4-ed26-4a19-b706-3c9aa3667376","name":"V.Alexander & Co. eAdaptor Proxy API","description":"

The V. Alexander eAdaptor Proxy API enables vendors to create secure data integrations with our internal ERP system CargoWise One.

Unlike traditional RESTful API, V. Alexander eAdaptor Proxy API only uses one single resource endpoint and POST method for all data retrieval, creation, update, and deletion. It is accepting only XML as request body instead of JSON.

Getting started

To get started, contact your V. Alexander IT team to obtain credentials and an API key. You will need the following information:

The email address for the technical contact at your company.
The IP address (or IP addresses) you will use to send requests to the API.

\n
Note: Access to the V. Alexander eAdaptor Proxy API is restricted to a list of allowed IP addresses. Please remember to make a note of the originating IP address so we can allow the new traffic.
\n

Authentication and Authorization

The V. Alexander eAdaptor Proxy API uses OAuth 2.0 along with an API key for authentication and authorization. All applications follow a basic pattern when accessing a V.Alexander eAdaptor Proxy API using OAuth 2.0. At a high level, you follow these steps:

Contact the V.Alexander IT team to obtain your access credentials if you don't have them before continuing.
Note: Access tokens expire after 1 hour. Client credentials do not use refresh tokens, and you will need to re-authenticate when your token expires.
Include the access token and API key with your request.
After your application obtains an access token, it should send the token and API Key to the V. Alexander eAdaptor Proxy API in the HTTP request header.
- Set an \"x-api-key\" header with the value set to your API key.
- Set an \"Authorization\" header with the value set to your access token.
\n

Scope

V. Alexander eAdaptor Proxy API controls authenticated access to resource and method with scope. Currently, there is only one scope available for the API: \"eadaptor.write\". Client app may need to provide this scope when obtaining access token.

Import and Test API Collection Locally in Postman

V. Alexander eAdaptor Proxy API Collection can be imported into your local Postman app for testing. You will need the Postman application to use this feature.

From this documentation, click Run in Postman and select the workspace to import the collection into.
Click on the edit option on the imported collection.
Add the following script into the Pre-request script section and update the clientId, clientSecret, apiKey, and tokenUrl constants. You will have received these data points from V. Alexander as part of the setup process.

// update this section\nconst clientId = 'your_client_id';\nconst clientSecret = 'your_client_secret';\nconst apiKey = \"your_api_key\";\nconst tokenUrl = 'token_url';\nconst domain = 'eadaptorproxy.valexanderapis.com';\nconst getTokenRequest = {\n  method: \"POST\",\n  url: tokenUrl,\n  body: {\n    mode: \"urlencoded\",\n    urlencoded: [\n      { key: \"client_id\", value: clientId },\n      { key: \"client_secret\", value: clientSecret },\n      { key: \"grant_type\", value: \"client_credentials\" },\n    ],\n  },\n};\npm.sendRequest(getTokenRequest, (err, response) => {\n  if (err) {\n    console.log(err);\n  }\n  const jsonResponse = response.json();\n  const newAccessToken = jsonResponse.access_token;\n  pm.environment.set(\"domain\", domain);\n  pm.environment.set(\"api_key\", apiKey);\n  pm.environment.set(\"access_token\", newAccessToken);\n});\n\n

After you save the script, Postman will automatically authenticate to the API, and you will able to make request to our API.

Support

For help regarding accessing the V. Alexander eAdaptor Proxy API, please contact V. Alexander IT. To help us address your request efficiently, please include the following:

A detailed description of the issue
The request you made, including the HTTP headers
The response you received from the API

Troubleshooting

`403 Forbidden`

If you receive a 403 response, check your IP address to ensure it is the same IP address we allowed during setup. Testing from behind a web VPN will change your IP address, and the API will block your request.

If receive a 5XX error, it implies that we have hit an unexpected errors internally. Please kindly let us know.

API Reference

5XX Error responses

Despite the V. Alexander eAdaptor Proxy API accepts and returns payload in form of XML, when the API encounters unexpected internal error, it returns response in form of JSON.

Example

{\n    \"message\": \"Internal server error\"\n}\n\n

This means before client tries to parse the response, it is recommended to check for the HTTP status first and determine if the response will be in form of XML or JSON.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting started","slug":"getting-started"},{"content":"Support","slug":"support"},{"content":"API Reference","slug":"api-reference"}],"owner":"12752850","collectionId":"4939fed4-ed26-4a19-b706-3c9aa3667376","publishedId":"2s8YsnYcEp","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-06T20:17:42.000Z"},"item":[{"name":"eadaptor","id":"b96e16c3-d02e-4d66-8c16-fc45bfbf3a27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"xml"}}},"url":"https://{{domain}}/v1/eadaptor?response_file_link=true","description":"

Use this resource to interact with CargoWise One resources.

This endpoint returns responses in 2 different forms depending on the `response_file_link` query string parameter.

If `response_file_link` is set to `true`, then the element in response will contain a S3 pre-signed link for downloading the response file.

If `response_file_link` is set to `false` or not present, then element in response will contain CargoWise One response directly.

Query Parameters

response_file_link
The flag for controlling the data form in response.
If `response_file_link` is set to `true`, then the element in response will contain a S3 pre-signed link for downloading the response file.
If `response_file_link` is set to `false` or not present, then element n response will contain CargoWise One response directly.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"grant_type","value":""},{"key":"client_authentication","value":""}]},"isInherited":true,"source":{"_postman_id":"4939fed4-ed26-4a19-b706-3c9aa3667376","id":"4939fed4-ed26-4a19-b706-3c9aa3667376","name":"V.Alexander & Co. eAdaptor Proxy API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","eadaptor"],"host":["{{domain}}"],"query":[{"key":"response_file_link","value":"true"}],"variable":[]}},"response":[{"id":"153648e4-e50c-439c-8d0d-e950b9e7a343","name":"415 Unsupported Media","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"access_token","type":"text"},{"key":"x-api-key","value":"api_key","type":"text"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tForwardingShipment\n\t\t\t\t\tSBNASVE123456\n\t\t\t\t\n\t\t\t\n\t\t\n\t","options":{"raw":{"language":"xml"}}},"url":"https://{{domain}}/v1/eadaptor"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 23 Nov 2022 16:59:02 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"297"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"8eda6fb5-6a69-4beb-a66b-68127ad845fe"},{"key":"x-amz-apigw-id","value":"cEGlhFKToAMFUvw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-637e5156-17878a3a3623dc587b8ce6e2"}],"cookie":[],"responseTime":null,"body":" \n\n\n ERR\n \n Unclosed tag 'UniversalShipmentRequest'.\n"},{"id":"c1f00be5-35da-4a74-a765-0cd30843b636","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"access_token","type":"text"},{"key":"x-api-key","value":"api_key","type":"text"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tForwardingShipment\n\t\t\t\t\tSBNASVE123456\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n","options":{"raw":{"language":"xml"}}},"url":"https://{{domain}}/v1/eadaptor"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Date","value":"Wed, 23 Nov 2022 17:00:20 GMT"},{"key":"Content-Type","value":"application/xml"},{"key":"Content-Length","value":"255"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"168759c5-40a7-4e76-b8b2-9fc237abcbd7"},{"key":"x-amz-apigw-id","value":"cEGxnFxooAMFlXQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-637e51a3-6a204c1d2c82ef5826200163"}],"cookie":[],"responseTime":null,"body":"\n\n PRS\n \n \n The UniversalShipment XML data goes here\n \n \n \n"}],"_postman_id":"b96e16c3-d02e-4d66-8c16-fc45bfbf3a27"}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""},{"key":"grant_type","value":""},{"key":"client_authentication","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"91f6fb89-e26f-41c9-97ba-9dfb7bf38a29","type":"text/javascript","exec":["const tokenUrl = pm.environment.get(\"access_token_url\");","const clientId = pm.environment.get(\"client_id\");","const clientSecret = pm.environment.get(\"client_secret\");","","const getTokenRequest = {"," method: \"POST\","," url: tokenUrl,"," body: {"," mode: \"urlencoded\","," urlencoded: ["," { key: \"client_id\", value: clientId },"," { key: \"client_secret\", value: clientSecret },"," { key: \"grant_type\", value: \"client_credentials\" },"," ],"," },","};","","pm.sendRequest(getTokenRequest, (err, response) => {"," if (err) {"," console.log(err);"," }",""," const jsonResponse = response.json();"," const newAccessToken = jsonResponse.access_token;",""," pm.environment.set(\"access_token\", newAccessToken);","});"]}},{"listen":"test","script":{"id":"e782f55b-31b7-4c91-ab4b-f60103fdca42","type":"text/javascript","exec":[""]}}]}