FedEx-пен интеграция мысалы

Бұл оқыту сабағында біз FedEx-пен интеграцияны қалай жасау керектігін көрсетеміз.

1. Алдын ала дайындық

1.1. FedEx-те аккаунт жасаңыз

Әзірлеуші порталына аккаунт жасаңыз.

1.2. Жобаларды жасаңыз және токендер алыңыз

Менің жобаларым бөлімінде 2 жоба жасаңыз және client id мен client secret-ті сақтаңыз.

Бірінші жоба жеткізілімдерді басқару үшін.

Екінші жоба жеткізілімдерді бақылау үшін.

1.3. Жеткізілімдер үшін статустар жасаңыз

Тапсырыстар қоймасының статустар қоймасында статустар жасаңыз:

order_delivery
order_delivery_started
ready_for_pickup

1.4. Статустарды бақылау үшін оқиға жасаңыз

Оқиғалар модулінде тапсырыс статусын order_delivery өзгерту үшін оқиға жасаңыз.

1.5. Жеткізілім үшін коллекция жасаңыз

Интеграция коллекциялары модулінде жеткізілім үшін атрибуттармен коллекция жасаңыз:

name (string)
address (string)
phone_number (string)
city (string)
state_code (string)
postal_code (string)
country_code (string)
tracking_number (string)
transaction_id (string)
ship_datestamp (string)
delivery_datestamp (string)

1.6. Тест тапсырысын жасаңыз

Тапсырыс жасаңыз және осы тапсырыс үшін коллекцияға жазба жасаңыз.

2. Жеткізілім жасау

2.1. Жеткізілім оқиғасын бақылау

оқиғалар нодасын жұмыс алаңына апарыңыз.
Нода атауын енгізіңіз.
"Set" өрісіндегі мәнді "orderEvent" етіп өзгертіңіз.
Оқиға "msg.orderEvent" объектісінде сақталады және оны басқа нодаларда пайдалануға болады.
Тізімнен "order delivery" оқиғаны таңдаңыз және "submit" батырмасын басыңыз.

2.2. Токен алу

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.
YOUR_CLIENT_ID және OUR_CLIENT_SECRET мәндерін өзіңіздікімен ауыстырыңыз.

msg.payload = {
    'grant_type': 'client_credentials',
    'client_id': 'YOUR_CLIENT_ID',
    'client_secret': 'YOUR_CLIENT_SECRET'
}
msg.headers = {
    'Content-Type': 'application/x-www-form-urlencoded'
}

return msg;

Параметрлер туралы толығырақ FedEx құжаттамасынан білуге болады.

http сұрау нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Method" өрісінде "POST" нұсқасын таңдаңыз.
"Data" өрісінде "Send as request body" нұсқасын таңдаңыз.
"Link" өрісіне https://apis-sandbox.fedex.com/oauth/token сілтемесін енгізіңіз.
"Return" өрісінде "Object JSON" нұсқасын таңдаңыз.

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.

msg.access_token = msg.payload.access_token;

return msg;

2.3. Жеткізілім жасау

api нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Find collection rows" әдісін таңдаңыз және "Data" өрісіне төмендегі кодты енгізіңіз.

{
  "collectionIdentifier": "delivery",
  "entityId": "{{orderEvent.order.id}}",
  "entityType": "orders",
  "langCode": "en_US",
  "limit": 1,
  "offset": 0
}

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.

// бұрын сақталған токенді аламыз
const token = msg.access_token;

// заголовкаларды орнатамыз
msg.headers = {
    'Content-Type': 'application/json',
    'authorization': `Bearer ${token}`
};

// алдыңғы қадамнан коллекцияны аламыз
const collection = msg.payload.items[0];
// массивті объектіге айналдырамыз
const formData = collection.formData.reduce((acc, item) => {
  acc[item.marker] = item.value;
  return acc;
}, {});
// формадан алушының параметрлерін орнатамыз
const recipient = {
  "address": {
    "streetLines": [
      formData.address
    ],
    "city": formData.city,
    "stateOrProvinceCode": formData.state_code,
    "postalCode": formData.postal_code,
    "countryCode": formData.country_code
  },
  "contact": {
    "personName": formData.name,
    "phoneNumber": formData.phone_number
  }
}
// msg-те коллекция деректерін орнатамыз, болашақта пайдалану үшін
msg.collection = collection;
// fedex үшін сұрау параметрлерін орнатамыз
msg.payload = {
  "labelResponseOptions": "URL_ONLY",
  "accountNumber": {
    "value": "510087020"
  },
  "requestedShipment": {
    "shipper": {
      "contact": {
        "personName": "ЖІБЕРУШІ АТЫ",
        "phoneNumber": "9018328595"
      },
      "address": {
        "streetLines": [
          "ЖІБЕРУШІ МЕКЕН-ЖАЙ 1"
        ],
        "city": "MEMPHIS",
        "stateOrProvinceCode": "TN",
        "postalCode": "38116",
        "countryCode": "US"
      }
    },
    "recipients": [
      recipient
    ],
    "serviceType": "STANDARD_OVERNIGHT",
    "packagingType": "СІЗДІҢ ҚАПТАУ",
    "pickupType": "DROPOFF_AT_FEDEX_LOCATION",
    "shippingChargesPayment": {
      "paymentType": "ЖІБЕРУШІ",
      "payor": {
        "responsibleParty": {
          "accountNumber": {
            "value": "510087020",
            "key": ""
          }
        },
        "address": {
          "streetLines": [
            "ЖІБЕРУШІ МЕКЕН-ЖАЙ 1"
          ],
          "city": "MEMPHIS",
          "stateOrProvinceCode": "TN",
          "postalCode": "38116",
          "countryCode": "US"
        }
      }
    },
    "labelSpecification": {},
    "requestedPackageLineItems": [
      {
        "customerReferences": [
          {
            "customerReferenceType": "CUSTOMER_REFERENCE",
            "value": `Collection${collection.id}`
          }
        ],
        "weight": {
          "units": "LB",
          "value": "20"
        }
      }
    ]
  }
};

return msg;

Параметрлер туралы толығырақ FedEx құжаттамасынан білуге болады.

http сұрау нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Method" өрісінде "POST" нұсқасын таңдаңыз.
"Data" өрісінде "Send as request body" нұсқасын таңдаңыз.
"Link" өрісіне https://apis-sandbox.fedex.com/ship/v1/shipments сілтемесін енгізіңіз.
"Return" өрісінде "Object JSON" нұсқасын таңдаңыз.

debug нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.

// жеткізілім деректерін аламыз
const shipment = msg.payload.output.transactionShipments[0];
// бұрын сақталған коллекция деректерін аламыз
const collection = msg.collection;

// форманың атрибуттарына жеткізілім деректерін жазамыз
const newFormData = [
  ...collection.formData
    .filter(item => !['transaction_id', 'ship_datestamp', 'delivery_datestamp', 'tracking_number'].includes(item.marker)),
  {
    marker: 'transaction_id',
    value: msg.payload.transactionId,
    type: 'string'
  },
  {
    marker: 'ship_datestamp',
    value: shipment.shipDatestamp,
    type: 'string'
  },
  {
    marker: 'delivery_datestamp',
    value: shipment.pieceResponses[0].deliveryDatestamp,
    type: 'string'
  },
  {
    marker: 'tracking_number',
    value: shipment.masterTrackingNumber,
    type: 'string'
  }
]

// коллекция деректерін жаңарту параметрлерін орнатамыз
msg.payload = {
  id: collection.id,
  collectionIdentifier: 'delivery',
  formData: {
    en_US: newFormData
  },
  formIdentifier: 'delivery_form',
  entityId: collection.entityId,
  entityType: collection.entityType,
  langCode: 'en_US',
}

// коллекция деректерін сақтаймыз, болашақта пайдалану үшін
msg.collection = msg.payload;

return msg;

api нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Update collection row" әдісін таңдаңыз.

2.4. Тапсырыс статусын жаңарту

api нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Update order status" әдісін таңдаңыз және "Data" өрісіне төмендегі кодты енгізіңіз.

{
  "orderId": "{{collection.entityId}}",
  "storageId": "test_order_storage",
  "statusIdentifier": "order_delivery_started"
}

debug нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.

3. Жеткізілім статусын бақылау

3.1. Бақылау үшін тапсырыстарды алу

интервал нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
Минуттардағы интервалды енгізіңіз.

api нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Find orders by status" әдісін таңдаңыз және "Data" өрісіне төмендегі кодты енгізіңіз.

{
  "storageId": "test_order_storage",
  "statusIdentifier": "order_delivery_started"
}

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.

msg.payload = msg.payload.items;

return msg;

split нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
Ұзындықты енгізіңіз.

api нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Find collection row" әдісін таңдаңыз және "Data" өрісіне төмендегі кодты енгізіңіз.

{
  "collectionIdentifier": "delivery",
  "entityId": "{{payload.id}}",
  "entityType": "orders",
  "langCode": "en_US",
  "limit": 1,
  "offset": 0
}

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.

msg.payload = msg.payload.items[0]

return msg;

switch нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
Тексеру үшін ереже қосыңыз. "not empty" шартын таңдаңыз.

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.

msg.trackingNumber = msg.payload
  .formData
  .find(item => item.marker === 'tracking_number')
  .value;

msg.collection = msg.payload;

return msg;

3.2. Токен алу

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.
YOUR_CLIENT_ID және OUR_CLIENT_SECRET мәндерін өзіңіздікімен ауыстырыңыз.

msg.payload = {
    'grant_type': 'client_credentials',
    'client_id': 'YOUR_CLIENT_ID',
    'client_secret': 'YOUR_CLIENT_SECRET'
}
msg.headers = {
    'Content-Type': 'application/x-www-form-urlencoded'
}

return msg;

Параметрлер туралы толығырақ FedEx құжаттамасынан білуге болады.

http сұрау нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Method" өрісінде "POST" нұсқасын таңдаңыз.
"Data" өрісінде "Send as request body" нұсқасын таңдаңыз.
"Link" өрісіне https://apis-sandbox.fedex.com/oauth/token сілтемесін енгізіңіз.
"Return" өрісінде "Object JSON" нұсқасын таңдаңыз.

3.3. Жеткізілім статусын алу

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.

const token = msg.payload.access_token;

msg.headers = {
    'content-type': 'application/json',
    'authorization': `Bearer ${token}`
};

msg.payload = {
  "trackingInfo": [
    {
      "trackingNumberInfo": {
        "trackingNumber": msg.trackingNumber
      }
    }
  ],
  "includeDetailedScans": true
}

return msg;

Параметрлер туралы толығырақ FedEx құжаттамасынан білуге болады.

http сұрау нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Method" өрісінде "POST" нұсқасын таңдаңыз.
"Data" өрісінде "Send as request body" нұсқасын таңдаңыз.
"Link" өрісіне https://apis-sandbox.fedex.com/track/v1/trackingnumbers сілтемесін енгізіңіз.
"Return" өрісінде "Object JSON" нұсқасын таңдаңыз.

функция нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Function" өрісіне мысал кодын енгізіңіз.

msg.payload = msg.payload.output.completeTrackResults[0].trackResults[0].latestStatusDetail.statusByLocale;

return msg;

3.4. Тапсырыс статусын жаңарту

switch нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
Тексеру үшін ереже қосыңыз. "==" шартын таңдаңыз, мәнге "Ready for pickup" енгізіңіз.

api нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.
"Update order status" әдісін таңдаңыз және "Data" өрісіне төмендегі кодты енгізіңіз.

{
  "orderId": "{{collection.entityId}}",
  "storageId": "test_order_storage",
  "statusIdentifier": "ready_for_pickup"
}

debug нодасын жұмыс алаңына апарыңыз және алдыңғы қадамдағы нодамен қосыңыз.

FedEx-пен интеграция мысалы

1. Алдын ала дайындық​

2. Жеткізілім жасау​

3. Жеткізілім статусын бақылау​

1. Алдын ала дайындық

2. Жеткізілім жасау

3. Жеткізілім статусын бақылау