XpressConnect
  • Introduction
  • Version History
  • Overview
    • How It Works
    • Server
    • API Request/Response
    • Authentication
  • API Endpoints
    • Courier
      • List
    • Declaration
      • Submit
      • Query
      • Attach
    • Commodity
      • List
    • Claim
      • Submit
      • Query
      • Update
      • Attach Document
      • Detach Document
  • Models
    • Courier
    • Declaration
    • Item
    • Commodity
    • Claim
    • Claim Document
  • Reference
    • Example PHP Code
    • Country
    • Errors
Powered by GitBook
On this page
  • Authentication
  • Authentication Credentials

Was this helpful?

  1. Overview

Authentication

Authentication

Each API request must be authenticated.

Method 1: Signature ( Discontinued by July 2018 )

Authentication credentials is attached to each request via custom HTTP header as follow:

  • api-id - account ID.

  • api-sign - Signature of this request.

API Signture Generation

api-sign = hex( sha256(api_key + http_request_body) )

Example request body

{"foo":"bar"}`

Resultant signature with “53cr3t” API key: 10ce7ebb62e85939a26d030a6f1709bb279d0181

Method 2: HTTP Basic Auth

User: api-id

Password: api-key

Authentication Credentials

api-id and api-key will be provided by XpressCover.

PreviousAPI Request/ResponseNextCourier

Last updated 6 years ago

Was this helpful?