Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleImportant Items to Note
  • Authentication is needed for most endpoints. You will need to send an authorization token or do a basic authentication with the call.
  • Dates entered should be in milliseconds in UTC for JSON requests (e.g. 1559651878000) and ISO-8601 standard for XML requests (e.g. 2019-06-04T07:36:53).
  • Dates returned are formatted according to the Operations App global options settings and localized to where the order was picked up/delivered with the timezone noted.
  • When entering the workOrderId parameter it must be in the following format:

    • route stop: r<stopID>
    • on demand pickup: p<orderID>
    • on demand delivery: d<orderID>

How will versioning be handled?

CXT Software will support the latest version, plus one previously published version. Response and Request objects, in addition to URLs, may have properties added with new releases. Business logic within the endpoints may change, and/or permission hardening may be applicable to existing endpoints with new releases 

Requirements

...

.

API Usage

  • You must understand exactly what is being sent, and why, for the various endpoints and all their properties.

  • Assistance can be requested if the EP/property documentation is unclear, and/or you do not understand how a property is intended to be used.

  • Note that endpoints/logic that may be hardened from security, permissions, and/or data integrity standpoint when the Operations App is updated.

Requirements

  • TLS 1.2
    • When calling the web services for CXT Cloud customers (designated by a domain in the format <CXTID>0.cxtsoftware.net), the calling system must connect with TLS 1.2
    • TLS 1.2 is not supported on Windows 2008 R2 or below. The calling system can run Windows 7, 8.1 or 2012 or newer, all of which support TLS 1.2

...

  1. Navigate to URL: https://<domain>/CxtWebService/CXTWCF.svc/api-docs
  2. Authenticate by either getting an authentication token or using basic authentication. See Authenticate. Depending on the user type allowed to access the endpoint, you may need different tokens.  

  3. If getting an authorization token, place token in the Authorization Token box at the top. 

    div

    Image Modified

  4. Make endpoint requests in JSON or XML

...

  • Driver endpoint: /v2/Authentication/Drivers 

    div

    • Valid duration of an authentication token: 30 days  

    NotetitleX Dispatch User Note
  • Internet User endpoint: /v2/Authentication/InetUser 

    div

    • Valid duration of an authentication token: 20 minutes

    Note
    titleX Dispatch User Note
  • Human Resources endpoint: /v2/Authentication/Worker  

    div


    • Valid duration of an authentication token: 30 days

    Note
  • Operations App User endpoint: /v2/Authentication/XdUser 

    div

    • Valid duration of an authentication token: 3 hours 

Token expiration is automatically extended with each call. 

...

Basic authentication credentials must be sent with every request, base64 encoded and the username must be prefixed with 1 or 4 values to distinguish user type:

  • Driver prefix: DRIVER
    • Internet User prefix: INET
    • Human Resources prefix: WORKER
    • Operations App User prefix: XDISPATCH

An example of an internet user with the username "cxtsupport" is "INET-cxtsupport".

...