Minh  Nguyet

Minh Nguyet

1659090240

Cách Sử Dụng API JavaScript Của Yêu Cầu Thanh toán Gốc

Một ngày nọ, tôi đang duyệt một số bài báo. Một trong những bài viết này đã mô tả API yêu cầu thanh toán.

Vào thời điểm đó, tôi chưa bao giờ nghe nói về nó trước đây, nhưng nó làm tôi thích thú.

Bất cứ khi nào chúng tôi xây dựng các trang web cho phép mọi người trả tiền cho một thứ gì đó, chúng tôi bước vào một cấp độ khó mới.

(May mắn thay, Stripe và những người khác đã làm cho việc này dễ dàng hơn một chút)

Nhưng sẽ tuyệt biết bao nếu nó chỉ đơn giản là một API trong trình duyệt? 🤔

Những lời cầu nguyện của chúng tôi dường như đã được lắng nghe vì giờ đây chúng tôi có quyền truy cập vào API yêu cầu thanh toán .

Trong video bên dưới, bạn sẽ thấy trải nghiệm hoàn chỉnh cho người dùng cuối.

1 bản demo API thanh toán

API yêu cầu thanh toán là gì?

Đầu tiên, cần lưu ý rằng API yêu cầu thanh toán không phải là một cách mới để thanh toán cho mọi thứ. Thay vào đó, đó là một quy trình được tối ưu hóa cho cả người tiêu dùng và người bán để có trải nghiệm gốc liền mạch khi thanh toán trực tuyến.

Kinh nghiệm với quy trình yêu cầu thanh toán là người tiêu dùng không còn phải điền vào nhiều biểu mẫu có chứa tất cả các loại chi tiết.

Thay vào đó, họ tận dụng những gì đã được thiết lập trong trình duyệt của họ.

Và điều này hoàn toàn có ý nghĩa, phải không?

Tại sao tôi cần phải điền địa chỉ giao hàng của mình trên mọi trang web, nó hiếm khi thay đổi và đối với các chi tiết cá nhân cũng vậy.

Vì vậy, tại sao không tận dụng điều này trong trình duyệt?

Thiết lập thanh toán

Hãy xem cách chúng tôi có thể sử dụng API yêu cầu thanh toán này trong ứng dụng của mình.

Đối với bản demo này, tôi sẽ mô phỏng một nút đóng góp nơi mọi người có thể quyên góp một đô la vì họ yêu thích nội dung.

Lưu ý thứ hai là bạn có thể tận dụng Bobbucks khi thử nghiệm điều này. Đây là một ứng dụng giúp xử lý các khoản thanh toán demo.

Hãy tạo nút mẫu và hộp văn bản với một số thông tin cho người dùng.

<button id="checkout">Donate 1$</button>
<div id="response">You won't be actually charged, give it a test drive 🤘</div>

Chúng tôi phải đính kèm một trình xử lý nhấp chuột vào nút để bắt đầu quá trình thanh toán.

button.addEventListener('click', () => {
  // Do something
});

Bước tiếp theo là thiết lập yêu cầu thanh toán . Ở dạng cơ bản nhất, nó trông như thế này:

const request = new PaymentRequest(paymentMethods, paymentDetails);

Các phương thức thanh toán có thể chứa danh sách các phương thức thanh toán được hỗ trợ. Mỗi mục trong đối tượng bao gồm hai tham số.

  • supportedMethods: Chuỗi dựa trên URL trỏ đến điểm cuối thanh toán
  • data: Thông tin tùy chọn do nhà cung cấp thanh toán cung cấp

Nếu bây giờ chúng tôi lấy Bobbucks (nhà cung cấp dịch vụ thanh toán demo của chúng tôi) làm ví dụ, chúng tôi có thể bắt đầu điều đó với ngữ cảnh sau.

const paymentMethods = [{
  supportedMethods: 'https://bobbucks.dev/pay'
}];

Bobbucks không lấy bất kỳ dữ liệu tùy chọn nào.

Phần thứ hai của yêu cầu là dữ liệu xung quanh những gì chúng tôi đang trả tiền.

Nói chung, điều này rất có thể đến từ giỏ hàng của bạn, nhưng vì chúng tôi sử dụng khoản đóng góp tĩnh 1 đô la, nên chúng tôi có thể cung cấp cho nó được mã hóa cứng.

const paymentDetails = {
  id: 'demo-123',
  displayItems: [
    {
      label: 'Support for this blog',
      amount: { currency: 'USD', value: '1.00' }
    }
  ],
  total: {
    label: 'Total',
    amount: { currency: 'USD', value: '1.00' }
  }
}

Bây giờ chúng ta đã có tất cả thông tin, hãy bắt đầu thực hiện và bắt đầu yêu cầu thanh toán khi người dùng nhấp vào nút.

button.addEventListener("click", () => {
  request.show().then( (paymentResponse) => {
    paymentResponse.complete("success").then(() => {
      response.innerText = "Thanks for your donation 💖";
    });
  });
});

Bây giờ hãy nhấp vào nút, và bạn sẽ thấy điều kỳ diệu xảy ra 🪄.

Phát lại phiên nguồn mở

OpenReplay là bộ mã nguồn mở, phát lại phiên cho phép bạn xem người dùng làm gì trên ứng dụng web của mình, giúp bạn khắc phục sự cố nhanh hơn. OpenReplay được tự lưu trữ để kiểm soát toàn bộ dữ liệu của bạn.

replayer.png

Bắt đầu tận hưởng trải nghiệm gỡ lỗi của bạn - bắt đầu sử dụng OpenReplay miễn phí .

Xử lý khoản thanh toán

Thật tốt khi lưu ý rằng mặc dù API này xử lý tất cả các phép thuật thanh toán, bạn vẫn cần xử lý khoản thanh toán từ phía mình.

Trong bản demo này, chúng tôi không đi vào chi tiết về điều đó, nhưng bạn có thể tích hợp một số xác thực phía máy chủ về việc thanh toán có thành công hay không và dữ liệu nào bạn cần xử lý dựa trên phản hồi.

Để hiển thị một phản hồi, nó có sẵn dưới dạng đối tượng trả về từ phương thức show.

button.addEventListener("click", () => {
  request.show().then( (paymentResponse) => {
   console.log(paymentResponse); 
   // Handle payment before showing the success!
   paymentResponse.complete("success").then(() => {
      response.innerText = "Thanks for your donation 💖";
    });
  });
});

Đối tượng phản hồi này sẽ trông giống như thế này.

details: {bobbucks_token_id: 'ABCDEADBEEF', message: 'Thanks for using BobBucks!'}
methodName: "https://bobbucks.dev/pay"
onpayerdetailchange: null
payerEmail: null
payerName: null
payerPhone: null
requestId: "demo-123"
shippingAddress: null
shippingOption: null

Nhiều phương thức thanh toán

Cho đến nay, chúng tôi đã chơi với Bobbucks vì đây là một cách siêu dễ dàng để kiểm tra API này.

Nhưng điều gì sẽ xảy ra nếu chúng ta bước vào một tình huống thực tế, chúng ta thường muốn cung cấp cho người dùng nhiều tùy chọn nhà cung cấp dịch vụ thanh toán.

Ví dụ, hãy sử dụng Google Pay. Thật may mắn cho chúng tôi, Google Pay cũng có một chế độ demo mà chúng tôi có thể sử dụng để thử nghiệm.

Như đã đề cập ở phần đầu, các phương thức thanh toán có thể chấp nhận nhiều nhà cung cấp.

Hãy thêm Google Pay vào đó.

const paymentMethods = [
  {
    supportedMethods: "https://bobbucks.dev/pay"
  },
  {
    supportedMethods: "https://google.com/pay"
  }
];

Hãy nhớ tôi đã nói với bạn về các đối tượng dữ liệu khác nhau mà chúng tôi có thể cung cấp? Google Pay là một trong những công cụ cung cấp cho chúng tôi đối tượng này.

Bạn có thể tìm thấy toàn bộ đối tượng trên trang web tài liệu của Google .

Nhưng nói chung, nó sẽ trông giống như thế này.

const paymentMethods = [
  {
    supportedMethods: "https://bobbucks.dev/pay"
  },
  {
    supportedMethods: "https://google.com/pay",
    data: {
      environment: "TEST",
      apiVersion: 2,
      apiVersionMinor: 0,
      merchantInfo: {
        // merchantId: '12345678901234567890',
        merchantName: "Example Merchant"
      },
      allowedPaymentMethods: [
        {
          type: "CARD",
          parameters: {
            allowedAuthMethods: ["PAN_ONLY", "CRYPTOGRAM_3DS"],
            allowedCardNetworks: [
              "AMEX",
              "DISCOVER",
              "INTERAC",
              "JCB",
              "MASTERCARD",
              "MIR",
              "VISA"
            ]
          },
          tokenizationSpecification: {
            type: "PAYMENT_GATEWAY",
            parameters: {
              gateway: "example",
              gatewayMerchantId: "exampleGatewayMerchantId"
            }
          }
        }
      ]
    }
  }
];

Khá nhiều dữ liệu, tôi sẽ không đi vào chi tiết, nhưng nó cho Google Pay biết bạn chấp nhận những phương thức nào và bạn muốn xử lý khoản thanh toán như thế nào.

Bây giờ, nếu chúng tôi mở lại thanh toán của mình, chúng tôi sẽ thực hiện một bước trung gian, nơi chúng tôi có tùy chọn để chọn nhà cung cấp dịch vụ thanh toán mà chúng tôi muốn sử dụng.

2 Nhiều phương thức thanh toán

Yêu cầu các tùy chọn thanh toán

Cho đến nay, chúng tôi chỉ yêu cầu mọi người trả tiền. Chúng tôi không quan tâm đến bất kỳ chi tiết nào.

Nhưng điều gì sẽ xảy ra nếu chúng ta có một sản phẩm cần vận chuyển? Hay chúng tôi muốn biết địa chỉ email của người dùng để có thể gửi sách điện tử cho họ?

Đó là nơi chúng tôi có thể sử dụng các tùy chọn thanh toán.

Đây là nơi chúng tôi có thể đặt tùy chọn thứ ba trên trình tạo yêu cầu thanh toán.

const paymentOptions = {
  requestPayerName: true,
  requestPayerEmail: true,
  requestPayerPhone: true,
  requestShipping: true,
  shippingType: "shipping"
};

const request = new PaymentRequest(paymentMethods, paymentDetails, paymentOptions);

Bây giờ khi chúng tôi nhấp vào nút thanh toán, chúng tôi thấy một số tùy chọn bổ sung mà chúng tôi phải điền vào trước khi có thể tiếp tục.

3 Thông tin bổ sung về thanh toán

Thử nghiệm

Tôi chắc rằng đây là phần mà hầu hết các bạn đang chờ đợi, một bản demo để tự mình thử.

Hãy thử nghiệm CodePen này .

Liên kết: https://blog.openreplay.com/using-the-native-payment-request-javascript-api

#javascript #api

What is GEEK

Buddha Community

Cách Sử Dụng API JavaScript Của Yêu Cầu Thanh toán Gốc
Minh  Nguyet

Minh Nguyet

1659090240

Cách Sử Dụng API JavaScript Của Yêu Cầu Thanh toán Gốc

Một ngày nọ, tôi đang duyệt một số bài báo. Một trong những bài viết này đã mô tả API yêu cầu thanh toán.

Vào thời điểm đó, tôi chưa bao giờ nghe nói về nó trước đây, nhưng nó làm tôi thích thú.

Bất cứ khi nào chúng tôi xây dựng các trang web cho phép mọi người trả tiền cho một thứ gì đó, chúng tôi bước vào một cấp độ khó mới.

(May mắn thay, Stripe và những người khác đã làm cho việc này dễ dàng hơn một chút)

Nhưng sẽ tuyệt biết bao nếu nó chỉ đơn giản là một API trong trình duyệt? 🤔

Những lời cầu nguyện của chúng tôi dường như đã được lắng nghe vì giờ đây chúng tôi có quyền truy cập vào API yêu cầu thanh toán .

Trong video bên dưới, bạn sẽ thấy trải nghiệm hoàn chỉnh cho người dùng cuối.

1 bản demo API thanh toán

API yêu cầu thanh toán là gì?

Đầu tiên, cần lưu ý rằng API yêu cầu thanh toán không phải là một cách mới để thanh toán cho mọi thứ. Thay vào đó, đó là một quy trình được tối ưu hóa cho cả người tiêu dùng và người bán để có trải nghiệm gốc liền mạch khi thanh toán trực tuyến.

Kinh nghiệm với quy trình yêu cầu thanh toán là người tiêu dùng không còn phải điền vào nhiều biểu mẫu có chứa tất cả các loại chi tiết.

Thay vào đó, họ tận dụng những gì đã được thiết lập trong trình duyệt của họ.

Và điều này hoàn toàn có ý nghĩa, phải không?

Tại sao tôi cần phải điền địa chỉ giao hàng của mình trên mọi trang web, nó hiếm khi thay đổi và đối với các chi tiết cá nhân cũng vậy.

Vì vậy, tại sao không tận dụng điều này trong trình duyệt?

Thiết lập thanh toán

Hãy xem cách chúng tôi có thể sử dụng API yêu cầu thanh toán này trong ứng dụng của mình.

Đối với bản demo này, tôi sẽ mô phỏng một nút đóng góp nơi mọi người có thể quyên góp một đô la vì họ yêu thích nội dung.

Lưu ý thứ hai là bạn có thể tận dụng Bobbucks khi thử nghiệm điều này. Đây là một ứng dụng giúp xử lý các khoản thanh toán demo.

Hãy tạo nút mẫu và hộp văn bản với một số thông tin cho người dùng.

<button id="checkout">Donate 1$</button>
<div id="response">You won't be actually charged, give it a test drive 🤘</div>

Chúng tôi phải đính kèm một trình xử lý nhấp chuột vào nút để bắt đầu quá trình thanh toán.

button.addEventListener('click', () => {
  // Do something
});

Bước tiếp theo là thiết lập yêu cầu thanh toán . Ở dạng cơ bản nhất, nó trông như thế này:

const request = new PaymentRequest(paymentMethods, paymentDetails);

Các phương thức thanh toán có thể chứa danh sách các phương thức thanh toán được hỗ trợ. Mỗi mục trong đối tượng bao gồm hai tham số.

  • supportedMethods: Chuỗi dựa trên URL trỏ đến điểm cuối thanh toán
  • data: Thông tin tùy chọn do nhà cung cấp thanh toán cung cấp

Nếu bây giờ chúng tôi lấy Bobbucks (nhà cung cấp dịch vụ thanh toán demo của chúng tôi) làm ví dụ, chúng tôi có thể bắt đầu điều đó với ngữ cảnh sau.

const paymentMethods = [{
  supportedMethods: 'https://bobbucks.dev/pay'
}];

Bobbucks không lấy bất kỳ dữ liệu tùy chọn nào.

Phần thứ hai của yêu cầu là dữ liệu xung quanh những gì chúng tôi đang trả tiền.

Nói chung, điều này rất có thể đến từ giỏ hàng của bạn, nhưng vì chúng tôi sử dụng khoản đóng góp tĩnh 1 đô la, nên chúng tôi có thể cung cấp cho nó được mã hóa cứng.

const paymentDetails = {
  id: 'demo-123',
  displayItems: [
    {
      label: 'Support for this blog',
      amount: { currency: 'USD', value: '1.00' }
    }
  ],
  total: {
    label: 'Total',
    amount: { currency: 'USD', value: '1.00' }
  }
}

Bây giờ chúng ta đã có tất cả thông tin, hãy bắt đầu thực hiện và bắt đầu yêu cầu thanh toán khi người dùng nhấp vào nút.

button.addEventListener("click", () => {
  request.show().then( (paymentResponse) => {
    paymentResponse.complete("success").then(() => {
      response.innerText = "Thanks for your donation 💖";
    });
  });
});

Bây giờ hãy nhấp vào nút, và bạn sẽ thấy điều kỳ diệu xảy ra 🪄.

Phát lại phiên nguồn mở

OpenReplay là bộ mã nguồn mở, phát lại phiên cho phép bạn xem người dùng làm gì trên ứng dụng web của mình, giúp bạn khắc phục sự cố nhanh hơn. OpenReplay được tự lưu trữ để kiểm soát toàn bộ dữ liệu của bạn.

replayer.png

Bắt đầu tận hưởng trải nghiệm gỡ lỗi của bạn - bắt đầu sử dụng OpenReplay miễn phí .

Xử lý khoản thanh toán

Thật tốt khi lưu ý rằng mặc dù API này xử lý tất cả các phép thuật thanh toán, bạn vẫn cần xử lý khoản thanh toán từ phía mình.

Trong bản demo này, chúng tôi không đi vào chi tiết về điều đó, nhưng bạn có thể tích hợp một số xác thực phía máy chủ về việc thanh toán có thành công hay không và dữ liệu nào bạn cần xử lý dựa trên phản hồi.

Để hiển thị một phản hồi, nó có sẵn dưới dạng đối tượng trả về từ phương thức show.

button.addEventListener("click", () => {
  request.show().then( (paymentResponse) => {
   console.log(paymentResponse); 
   // Handle payment before showing the success!
   paymentResponse.complete("success").then(() => {
      response.innerText = "Thanks for your donation 💖";
    });
  });
});

Đối tượng phản hồi này sẽ trông giống như thế này.

details: {bobbucks_token_id: 'ABCDEADBEEF', message: 'Thanks for using BobBucks!'}
methodName: "https://bobbucks.dev/pay"
onpayerdetailchange: null
payerEmail: null
payerName: null
payerPhone: null
requestId: "demo-123"
shippingAddress: null
shippingOption: null

Nhiều phương thức thanh toán

Cho đến nay, chúng tôi đã chơi với Bobbucks vì đây là một cách siêu dễ dàng để kiểm tra API này.

Nhưng điều gì sẽ xảy ra nếu chúng ta bước vào một tình huống thực tế, chúng ta thường muốn cung cấp cho người dùng nhiều tùy chọn nhà cung cấp dịch vụ thanh toán.

Ví dụ, hãy sử dụng Google Pay. Thật may mắn cho chúng tôi, Google Pay cũng có một chế độ demo mà chúng tôi có thể sử dụng để thử nghiệm.

Như đã đề cập ở phần đầu, các phương thức thanh toán có thể chấp nhận nhiều nhà cung cấp.

Hãy thêm Google Pay vào đó.

const paymentMethods = [
  {
    supportedMethods: "https://bobbucks.dev/pay"
  },
  {
    supportedMethods: "https://google.com/pay"
  }
];

Hãy nhớ tôi đã nói với bạn về các đối tượng dữ liệu khác nhau mà chúng tôi có thể cung cấp? Google Pay là một trong những công cụ cung cấp cho chúng tôi đối tượng này.

Bạn có thể tìm thấy toàn bộ đối tượng trên trang web tài liệu của Google .

Nhưng nói chung, nó sẽ trông giống như thế này.

const paymentMethods = [
  {
    supportedMethods: "https://bobbucks.dev/pay"
  },
  {
    supportedMethods: "https://google.com/pay",
    data: {
      environment: "TEST",
      apiVersion: 2,
      apiVersionMinor: 0,
      merchantInfo: {
        // merchantId: '12345678901234567890',
        merchantName: "Example Merchant"
      },
      allowedPaymentMethods: [
        {
          type: "CARD",
          parameters: {
            allowedAuthMethods: ["PAN_ONLY", "CRYPTOGRAM_3DS"],
            allowedCardNetworks: [
              "AMEX",
              "DISCOVER",
              "INTERAC",
              "JCB",
              "MASTERCARD",
              "MIR",
              "VISA"
            ]
          },
          tokenizationSpecification: {
            type: "PAYMENT_GATEWAY",
            parameters: {
              gateway: "example",
              gatewayMerchantId: "exampleGatewayMerchantId"
            }
          }
        }
      ]
    }
  }
];

Khá nhiều dữ liệu, tôi sẽ không đi vào chi tiết, nhưng nó cho Google Pay biết bạn chấp nhận những phương thức nào và bạn muốn xử lý khoản thanh toán như thế nào.

Bây giờ, nếu chúng tôi mở lại thanh toán của mình, chúng tôi sẽ thực hiện một bước trung gian, nơi chúng tôi có tùy chọn để chọn nhà cung cấp dịch vụ thanh toán mà chúng tôi muốn sử dụng.

2 Nhiều phương thức thanh toán

Yêu cầu các tùy chọn thanh toán

Cho đến nay, chúng tôi chỉ yêu cầu mọi người trả tiền. Chúng tôi không quan tâm đến bất kỳ chi tiết nào.

Nhưng điều gì sẽ xảy ra nếu chúng ta có một sản phẩm cần vận chuyển? Hay chúng tôi muốn biết địa chỉ email của người dùng để có thể gửi sách điện tử cho họ?

Đó là nơi chúng tôi có thể sử dụng các tùy chọn thanh toán.

Đây là nơi chúng tôi có thể đặt tùy chọn thứ ba trên trình tạo yêu cầu thanh toán.

const paymentOptions = {
  requestPayerName: true,
  requestPayerEmail: true,
  requestPayerPhone: true,
  requestShipping: true,
  shippingType: "shipping"
};

const request = new PaymentRequest(paymentMethods, paymentDetails, paymentOptions);

Bây giờ khi chúng tôi nhấp vào nút thanh toán, chúng tôi thấy một số tùy chọn bổ sung mà chúng tôi phải điền vào trước khi có thể tiếp tục.

3 Thông tin bổ sung về thanh toán

Thử nghiệm

Tôi chắc rằng đây là phần mà hầu hết các bạn đang chờ đợi, một bản demo để tự mình thử.

Hãy thử nghiệm CodePen này .

Liên kết: https://blog.openreplay.com/using-the-native-payment-request-javascript-api

#javascript #api

Top 10 API Security Threats Every API Team Should Know

As more and more data is exposed via APIs either as API-first companies or for the explosion of single page apps/JAMStack, API security can no longer be an afterthought. The hard part about APIs is that it provides direct access to large amounts of data while bypassing browser precautions. Instead of worrying about SQL injection and XSS issues, you should be concerned about the bad actor who was able to paginate through all your customer records and their data.

Typical prevention mechanisms like Captchas and browser fingerprinting won’t work since APIs by design need to handle a very large number of API accesses even by a single customer. So where do you start? The first thing is to put yourself in the shoes of a hacker and then instrument your APIs to detect and block common attacks along with unknown unknowns for zero-day exploits. Some of these are on the OWASP Security API list, but not all.

Insecure pagination and resource limits

Most APIs provide access to resources that are lists of entities such as /users or /widgets. A client such as a browser would typically filter and paginate through this list to limit the number items returned to a client like so:

First Call: GET /items?skip=0&take=10 
Second Call: GET /items?skip=10&take=10

However, if that entity has any PII or other information, then a hacker could scrape that endpoint to get a dump of all entities in your database. This could be most dangerous if those entities accidently exposed PII or other sensitive information, but could also be dangerous in providing competitors or others with adoption and usage stats for your business or provide scammers with a way to get large email lists. See how Venmo data was scraped

A naive protection mechanism would be to check the take count and throw an error if greater than 100 or 1000. The problem with this is two-fold:

  1. For data APIs, legitimate customers may need to fetch and sync a large number of records such as via cron jobs. Artificially small pagination limits can force your API to be very chatty decreasing overall throughput. Max limits are to ensure memory and scalability requirements are met (and prevent certain DDoS attacks), not to guarantee security.
  2. This offers zero protection to a hacker that writes a simple script that sleeps a random delay between repeated accesses.
skip = 0
while True:    response = requests.post('https://api.acmeinc.com/widgets?take=10&skip=' + skip),                      headers={'Authorization': 'Bearer' + ' ' + sys.argv[1]})    print("Fetched 10 items")    sleep(randint(100,1000))    skip += 10

How to secure against pagination attacks

To secure against pagination attacks, you should track how many items of a single resource are accessed within a certain time period for each user or API key rather than just at the request level. By tracking API resource access at the user level, you can block a user or API key once they hit a threshold such as “touched 1,000,000 items in a one hour period”. This is dependent on your API use case and can even be dependent on their subscription with you. Like a Captcha, this can slow down the speed that a hacker can exploit your API, like a Captcha if they have to create a new user account manually to create a new API key.

Insecure API key generation

Most APIs are protected by some sort of API key or JWT (JSON Web Token). This provides a natural way to track and protect your API as API security tools can detect abnormal API behavior and block access to an API key automatically. However, hackers will want to outsmart these mechanisms by generating and using a large pool of API keys from a large number of users just like a web hacker would use a large pool of IP addresses to circumvent DDoS protection.

How to secure against API key pools

The easiest way to secure against these types of attacks is by requiring a human to sign up for your service and generate API keys. Bot traffic can be prevented with things like Captcha and 2-Factor Authentication. Unless there is a legitimate business case, new users who sign up for your service should not have the ability to generate API keys programmatically. Instead, only trusted customers should have the ability to generate API keys programmatically. Go one step further and ensure any anomaly detection for abnormal behavior is done at the user and account level, not just for each API key.

Accidental key exposure

APIs are used in a way that increases the probability credentials are leaked:

  1. APIs are expected to be accessed over indefinite time periods, which increases the probability that a hacker obtains a valid API key that’s not expired. You save that API key in a server environment variable and forget about it. This is a drastic contrast to a user logging into an interactive website where the session expires after a short duration.
  2. The consumer of an API has direct access to the credentials such as when debugging via Postman or CURL. It only takes a single developer to accidently copy/pastes the CURL command containing the API key into a public forum like in GitHub Issues or Stack Overflow.
  3. API keys are usually bearer tokens without requiring any other identifying information. APIs cannot leverage things like one-time use tokens or 2-factor authentication.

If a key is exposed due to user error, one may think you as the API provider has any blame. However, security is all about reducing surface area and risk. Treat your customer data as if it’s your own and help them by adding guards that prevent accidental key exposure.

How to prevent accidental key exposure

The easiest way to prevent key exposure is by leveraging two tokens rather than one. A refresh token is stored as an environment variable and can only be used to generate short lived access tokens. Unlike the refresh token, these short lived tokens can access the resources, but are time limited such as in hours or days.

The customer will store the refresh token with other API keys. Then your SDK will generate access tokens on SDK init or when the last access token expires. If a CURL command gets pasted into a GitHub issue, then a hacker would need to use it within hours reducing the attack vector (unless it was the actual refresh token which is low probability)

Exposure to DDoS attacks

APIs open up entirely new business models where customers can access your API platform programmatically. However, this can make DDoS protection tricky. Most DDoS protection is designed to absorb and reject a large number of requests from bad actors during DDoS attacks but still need to let the good ones through. This requires fingerprinting the HTTP requests to check against what looks like bot traffic. This is much harder for API products as all traffic looks like bot traffic and is not coming from a browser where things like cookies are present.

Stopping DDoS attacks

The magical part about APIs is almost every access requires an API Key. If a request doesn’t have an API key, you can automatically reject it which is lightweight on your servers (Ensure authentication is short circuited very early before later middleware like request JSON parsing). So then how do you handle authenticated requests? The easiest is to leverage rate limit counters for each API key such as to handle X requests per minute and reject those above the threshold with a 429 HTTP response. There are a variety of algorithms to do this such as leaky bucket and fixed window counters.

Incorrect server security

APIs are no different than web servers when it comes to good server hygiene. Data can be leaked due to misconfigured SSL certificate or allowing non-HTTPS traffic. For modern applications, there is very little reason to accept non-HTTPS requests, but a customer could mistakenly issue a non HTTP request from their application or CURL exposing the API key. APIs do not have the protection of a browser so things like HSTS or redirect to HTTPS offer no protection.

How to ensure proper SSL

Test your SSL implementation over at Qualys SSL Test or similar tool. You should also block all non-HTTP requests which can be done within your load balancer. You should also remove any HTTP headers scrub any error messages that leak implementation details. If your API is used only by your own apps or can only be accessed server-side, then review Authoritative guide to Cross-Origin Resource Sharing for REST APIs

Incorrect caching headers

APIs provide access to dynamic data that’s scoped to each API key. Any caching implementation should have the ability to scope to an API key to prevent cross-pollution. Even if you don’t cache anything in your infrastructure, you could expose your customers to security holes. If a customer with a proxy server was using multiple API keys such as one for development and one for production, then they could see cross-pollinated data.

#api management #api security #api best practices #api providers #security analytics #api management policies #api access tokens #api access #api security risks #api access keys

Autumn  Blick

Autumn Blick

1601381326

Public ASX100 APIs: The Essential List

We’ve conducted some initial research into the public APIs of the ASX100 because we regularly have conversations about what others are doing with their APIs and what best practices look like. Being able to point to good local examples and explain what is happening in Australia is a key part of this conversation.

Method

The method used for this initial research was to obtain a list of the ASX100 (as of 18 September 2020). Then work through each company looking at the following:

  1. Whether the company had a public API: this was found by googling “[company name] API” and “[company name] API developer” and “[company name] developer portal”. Sometimes the company’s website was navigated or searched.
  2. Some data points about the API were noted, such as the URL of the portal/documentation and the method they used to publish the API (portal, documentation, web page).
  3. Observations were recorded that piqued the interest of the researchers (you will find these below).
  4. Other notes were made to support future research.
  5. You will find a summary of the data in the infographic below.

Data

With regards to how the APIs are shared:

#api #api-development #api-analytics #apis #api-integration #api-testing #api-security #api-gateway

An API-First Approach For Designing Restful APIs | Hacker Noon

I’ve been working with Restful APIs for some time now and one thing that I love to do is to talk about APIs.

So, today I will show you how to build an API using the API-First approach and Design First with OpenAPI Specification.

First thing first, if you don’t know what’s an API-First approach means, it would be nice you stop reading this and check the blog post that I wrote to the Farfetchs blog where I explain everything that you need to know to start an API using API-First.

Preparing the ground

Before you get your hands dirty, let’s prepare the ground and understand the use case that will be developed.

Tools

If you desire to reproduce the examples that will be shown here, you will need some of those items below.

  • NodeJS
  • OpenAPI Specification
  • Text Editor (I’ll use VSCode)
  • Command Line

Use Case

To keep easy to understand, let’s use the Todo List App, it is a very common concept beyond the software development community.

#api #rest-api #openai #api-first-development #api-design #apis #restful-apis #restful-api

Marcelle  Smith

Marcelle Smith

1598083582

What Are Good Traits That Make Great API Product Managers

As more companies realize the benefits of an API-first mindset and treating their APIs as products, there is a growing need for good API product management practices to make a company’s API strategy a reality. However, API product management is a relatively new field with little established knowledge on what is API product management and what a PM should be doing to ensure their API platform is successful.

Many of the current practices of API product management have carried over from other products and platforms like web and mobile, but API products have their own unique set of challenges due to the way they are marketed and used by customers. While it would be rare for a consumer mobile app to have detailed developer docs and a developer relations team, you’ll find these items common among API product-focused companies. A second unique challenge is that APIs are very developer-centric and many times API PMs are engineers themselves. Yet, this can cause an API or developer program to lose empathy for what their customers actually want if good processes are not in place. Just because you’re an engineer, don’t assume your customers will want the same features and use cases that you want.

This guide lays out what is API product management and some of the things you should be doing to be a good product manager.

#api #analytics #apis #product management #api best practices #api platform #api adoption #product managers #api product #api metrics