The Bourque Web Services Interface serves as a centralized gateway, enabling our clients' systems to seamlessly retrieve and submit data from the Bourque Logistics system. This documentation outlines the key processes required for utilizing our Web Services Interface effectively.
\nAuthentication Token
To retrieve data from our Web Service, you first need to obtain a token and then make API calls to either one of the 2 versions of the API available:
Version One (V1) - This version requires two endpoint calls to retrieve data.
\nVersion Two (V2) - This version is optimized for small data sets.
\nBoth versions can return a request ID for tracking purposes. V1 is best suited for long-running processes, while V2 is more suitable for small data sets.
\nWhile the APIs listed here provide a foundation for integration, we offer additional APIs tailored to meet your specific needs. If you require access to data from any of our applications, please reach out to our support team. They will provide you with detailed information about our APIs and work with you to customize the data retrieval process to suit your requirements.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23759202","collectionId":"6621753b-0995-4e5c-9972-5b217f3cf32b","publishedId":"2s9YC7SBNb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"005c92"},"publishDate":"2023-09-20T20:55:56.000Z"},"item":[{"name":"Authentication Token","item":[{"name":"token","id":"dd5e09ef-64d5-476d-9dfb-15258457e280","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"webservices-sproc-gw-v1","type":"text","description":"This will be assgined to you.
\n"},{"key":"client_secret","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"text","description":"This will be assgined to you.
\n"},{"key":"scope","value":"xx-xxxxx-xxxx-xx, xxxx-xx-xxxxxx-xx","type":"text"}]},"url":"https://auth.test.railcl.com/connect/token","description":"To establish a connection with BDSGateway, you must request a Bearer Token from the Bourque Single Sign-On application token endpoint. You will receive a response with the following body structure:
{
\"access_token\": \"xxxxxxxx-xxxxxxxx-xxxxxxxx\",
\"expires_in\": 3600,
\"token_type\": \"Bearer\",
\"scope\": \"bds-stored-procedure-gw\"
}
The \"access_token\" property will hold the Bearer Token you've requested, which remains valid for one hour. It's essential to include this Bearer Token in the Authentication Header for all subsequent requests.
\n","urlObject":{"protocol":"https","path":["connect","token"],"host":["auth","test","railcl","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd5e09ef-64d5-476d-9dfb-15258457e280"}],"id":"e584b4dc-e877-47ec-ba11-7328c9847abf","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3bfbc9c1-d72f-462d-a308-8b1d21106370","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"68b5fe53-38d3-4b32-b32d-5df1f47e9203","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"e584b4dc-e877-47ec-ba11-7328c9847abf","description":""},{"name":"Version One (V1)","item":[{"name":"SubmitRequestV1","id":"bfc83c46-293b-4fd3-976d-05165b84fd31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"This will be assgined to you.
\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CustomerNumber","value":"ABC-COMPANY","type":"text","description":"Your customer number you have for all BDS Applications.
\n"},{"key":"UserName","value":"api_user","type":"text","description":"The UserID you use to login to BDS Applications.
\n"}],"body":{"mode":"raw","raw":"{\r\n\"requestedAction\": \"HELLO WORLD\",\r\n\"data\": \"{\\\"message\\\": \\\"This is a test\\\"}\"\r\n}"},"url":"https://bds-api.railcl.com/api/BDSGateway/SubmitRequestV1","description":"Please submit your request to this entry point in order to enqueue it for processing.
\nResponses:
\nData Model
\nStoredProcedureServiceResult
{
bool IsProcessed,
string Message,
int RequestID,
string Status
}
This will be assgined to you.
\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CustomerNumber","value":"ABC-COMPANY","type":"text","description":"Your customer number you have for all BDS Applications.
\n"},{"key":"UserName","value":"api_user","type":"text","description":"The UserID you use to login to BDS Applications.
\n"}],"url":"https://bds-api.railcl.com/api/BDSGateway/GetRequestStatus?requestID=123","description":"After submitting a request via the SubmitRequest entry point, you can retrieve the status of your request by querying this entry point using the provided RequestID.
\nResponses:
\nData Model:
\nStatusResponseModel
{
int RequestID,
string Message,
string Status,
string Data
}
To retrieve data using V1, you first need to call the SubmitRequestV1 endpoint to obtain a request ID. Next step is to call the GetRequestStatus endpoint to check the status of your request and retrieve the data once it's available.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"259a160d-c434-4a8a-85fc-1baa959cb099","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"4aeab23b-2fae-4362-bbbe-d7f05a168e84","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"7db4717e-04ce-4ba6-8178-789f86fc565a"},{"name":"Version Two (V2)","item":[{"name":"Hello World","event":[{"listen":"prerequest","script":{"id":"0a33fbf3-200b-4349-8053-8bf7ea0960ca","exec":[""],"type":"text/javascript","packages":{}}}],"id":"93867007-94b9-4649-aed3-df948c1137be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"UserName","value":"api_user","type":"text"},{"key":"ApiKey","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"message\": \"This is Test call to the Hello World API\"\r\n}"},"url":"https://bds-api.railcl.com/api/v2/customers/ABC-COMPANY/actions/hello world","description":"This API endpoint allows you to send a POST request to trigger a \"hello world\" action for a specific customer. The request should be sent to {{SPApiGatewayUrl}}/api/v2/customers/YMOL_TEST/actions/hello world.
\nThe request should include a JSON payload in the raw request body type with the following parameter:
\nmessage (string, optional): A message to be included in the action.In case of a successful execution, the API responds with a status code of 405 and a Content-Type of application/problem+json. The response body contains the following parameters:
\ntype (string): The type of the problem encountered.title (string): A title describing the problem.status (number): The status code of the response.traceId (string): A unique identifier for tracing the request.Version Two (V2) is a synchronous API that delivers data quickly in the response body. However, a timeout error will occur if the backend takes longer than 3 minutes to process the data.
\nEach API in V2 has a unique endpoint. Additionally, you need to include the customer number as part of the endpoint.
\nTo receive metadata about the requestID from the backend server, include the ?dataonly=false parameter in your GET request.
Furthermore, it is essential to include the UserName header value in your request.