Getting Started with the API

Use the information here to help you get started with your integration with the ePAL REST API.

Review the implementation details.

Review the information about how to authenticate requests. For more information, see the API Authentication topic.

A typical implementation can consist of the following steps:

Review the ePAL documentation and other materials. Specifically, review this Getting Started with the API section.
Go to https://app.epalglobal.co/ and complete the signup form.
Activate the account using the email that was sent during step 2.
Go to the ePAL Dashboard and retrieve your API credentials. Copy your client ID and secret. Keep this secret and safe. You will need to add them to each API request.
Use the Get welcome message request to check that your connection is correct. For more information, see the Get welcome message topic.

The Process transaction request is the request that you are lilely to use the most. Send the following transaction to test this request. This is a quote so it will not use your ePAL credits. For more information, see the Process transaction topic:

{
  "commands": {
    "executeTransaction": false,
    "calculateTaxExclusive": true,
    "calculateCustomDuties": true,
    "useShipping": "shippo",
    "getShippingRates": true
  },
  "addresses": [
    {
      "type": "SOURCE",
      "fullName": "Apple Inc.",
      "companyName": "Apple Inc.",
      "email": "contact@apple.com",
      "phone": "+1 408-996-1010",
      "street": "1 Apple Park Way",
      "city": "Cupertino",
      "county": "Santa Clara",
      "postalCode": "95014",
      "country": "US"
    },
    {
      "type": "DESTINATION",
      "fullName": "Customer Name",
      "companyName": "Customer Company",
      "email": "customer@email.com",
      "phone": "+353 61 123 456",
      "street": "No. 1 Charlotte Quay, Suite A2",
      "city": "Limerick",
      "postalCode": "V94 TW5E",
      "country": "IE"
    }
  ],
  "products": [
    {
      "clientSKU": "YOUR-SKU-123",
      "hs6Code": "852692",
      "description": "Your Product Name",
      "productType": "physical",
      "value": 99,
      "qty": 1,
      "originatingCountry": "US"
    }
  ],
  "transactionCurrency": "USD",
  "grossWeight": 500
}

Now you can use the Session ID that was generated by this quote to create labels, using the Generate shipping labels and documents request. For more information, see the Generate shipping labels and documents topic.