Content Comparison

This article describes the http APIs available to support the order process. It gives an overview of existing providers, and log tracing of API calls.

...

The follwing APIs exist to support the order process.

PlaceOrder / ValidateOrder

API calling process

1. There is an active order in web viewer stored in an order object

2. Order object is sent in PlaceOrder / ValidateOrder call

3. If call is successful, PlaceOrder / ValidateOrder call returns an order object. This returned object is used to update the active order.

   1. Prices on order lines in active order is updated

   2. Total price and charges on the active order is updated

   3. Parts may be marked as NLA or a replacement may be returned and active order is updated based on this

   4. Messages on order or order lines are set on the active order

   5. Error code on order lines or on order is set on active order. If an error code exist the corresponding message will display in red and it will not be possible to place the order

4. Result is presented

   1. For ValidateOrder call user stays on the order page and gets to see the active order

   2. For PlaceOrder call user is either

      1. directed to a confirmation page if PlaceOrder call accepted the order

      2. stays on the order page and gets to see the active order if PlaceOrder call did not accept the order

Validation

Order is validated when parts are added and when user arrives at order. The validation can be turned off using a setting.

...

<system.serviceModel>
   <bindings>
      <basicHttpBinding>
         <binding name="PostCustomPlaceOrderServiceSoapBinding" maxReceivedMessageSize="20000000" maxBufferSize="20000000" maxBufferPoolSize="20000000">
            <readerQuotas maxDepth="32" maxArrayLength="200000000" maxStringContentLength="200000000" />
            <security mode="TransportCredentialOnly">
               <transport clientCredentialType="Windows" />
            </security>
         </binding>
      </basicHttpBinding>
   </bindings>
   <client>
      <endpoint address="http://www.domain.com/WebServices/CustomOrderService/post" binding="basicHttpBinding" bindingConfiguration="PostCustomPlaceOrderServiceSoapBinding" contract="CustomPlaceOrderService.CustomOrderServicePostPort" name="CustomOrderServicePost" />
   </client>
</system.serviceModel>

Tracing

Every API provides the possibility to write trace logs. Trace log is turned on using the below xml in profile.config.

...

See separate article: Log archive (API logs)

Authentication in API calls

API calls may be protected by http basic authentication or api-keys (version 5.2.3 and later) and all REST providers support this security method. 
Basic

<PlaceOrderProvider>
  <RESTPlaceOrderProvider authorization-scheme="Basic" authentication-name="username" authentication-password="password" save-external-order-to-server-database="truefalse" delete-old-trace-log-after-number-of-folder="30" trace-folder="FC:\Signifikant\Log\APIXml\" delete-old-trace-log-after-number-of-folder="60" impersonation="true" domain="localhost" user-name="xyz" password="xyz" url="https://www.domain.com/api/"/>
</PriceProvider>

The tracing will place two files for each call, one request and one response, in this location. Log files will be placed in sub folders per date and old log files will be deleted after 30 folders by default. Default value can be changed by using delete-old-trace-log-after-number-of-folder="30".

Files will be named according to this example:

   Request_PlaceOrder_e1f540ea-f4f8-4e8e-a123-76d451d5dba8_28.xml
   Response_PlaceOrder_e1f540ea-f4f8-4e8e-a123-76d451d5dba8_28.xml

e1f540ea-f4f8-4e8e-a123-76d451d5dba8 is the GUID of the session. _28 is a counter which will be kept the same for request and respose.

The Request and Response log files will contain the exact content of the calls and responses in xml or json (depending on API). Response file will also contain a response time to measure time for other end point to reply.

...

PlaceOrderProvider>

ApiKey

This option is available from version 5.2.3 and later.

<PlaceOrderProvider>
  <RESTPlaceOrderProvider authorization-scheme="BasicApiKey" authenticationapi-key-name="usernameapi-key" authenticationapi-passwordkey="passwordABC123" save-external-order-to-server-database="false" delete-old-trace-log-after-number-of-folder="30" trace-folder="C:\Log\" url="https://www.domain.com/api/"/>
</PlaceOrderProvider>

...