Xây dựng một Web API để tiếp xúc với các đối tượng của Salesforce.com

Tích hợp dễ dàng với dịch vụ IBM WebSphere Cast Iron Web API

Trong bài viết này, các nhà phát triển API có thể học cách sử dụng WebSphere® Cast Iron® Web API Services của IBM® để tạo ra một web API có thể được gọi để tạo ra một liên lạc trong hệ thống quản lý quan hệ khách hàng của Salesforce.com. Với IBM WebSphere Cast Iron Web API Services, bạn có thể tích hợp và tiếp xúc với các API chỉ với một vài cú nhấp chuột. Bạn cũng có thể phân tích việc sử dụng web API của bạn thông qua các phân tích được cung cấp cũng như phổ biến cộng đồng web API của bạn thông qua một cổng thông tin phát triển thương hiệu với các mối liên kết cộng đồng.

Katherine Sanders, Triển khai dịch vụ WebSphere cho IBM Software, IBM

Ảnh của Katherine SandersKatherine Sanders là một chuyên gia CNTT hiện đang làm việc tại IBM Hursley, Vương quốc Anh. Cô đã làm việc tại IBM từ năm 2007 và hiện đang tập trung vào mảng tích hợp điện toán đám mây trên IBM WebSphere Cast Iron . Cô ấy có một nền tảng vững chắc trong phát triển phần mềm và các danh mục sản phẩm WebSphere. Katherine có bằng Cử nhân khoa học ngành khoa học máy tính từ Đại học Nottingham.



12 09 2013

Giới thiệu

Dùng thử Cast Iron Live Web API Services

Đăng kí ngay để nhận được 90 ngày dùng thử miễn phí từ Cast Iron Live Web API Services.

Web API là một kênh kinh doanh phát triển nhanh chóng giúp doanh nghiệp của bạn tiếp cận các thị trường mới và thu hút khách hàng cũng như các đối tác mới. Chúng cũng giúp bạn khai thác sự sáng tạo từ một cộng đồng lớn các nhà phát triển, chứ không chỉ giới hạn trong các nhà phát triển của công ty bạn.

Bởi vì các web API phơi bày các thông tin kinh doanh quan trọng như tài sản và các dịch vụ, danh mục sản phẩm hoặc danh sách điện thoại, chúng hoạt động như một nhân vật bên ngoài doanh nghiệp của bạn. Chúng nên được mô tả dễ dàng để sử dụng. Chúng cũng sử dụng kiểu kiến trúc REST (Representational State Transfer) vì thế chúng có thể được gọi dễ dàng trên một trình duyệt hay thiết bị di động.

Với WebSphere Cast Iron Web Services API của IBM, bạn có thể tích hợp và tiếp xúc với các API chỉ với một vài cú nhấp chuột. Bạn cũng có thể phân tích việc sử dụng web API của bạn thông qua các phân tích được cung cấp cũng như phổ biến cộng đồng web API của bạn thông qua một cổng thông tin phát triển thương hiệu với các mối liên kết cộng đồng. Bài viết này hướng dẫn bạn từng bước trong việc sử dụng WebSphere Cast Iron Web API để tạo ra một web API có thể được gọi để tạo ra một liên lạc trong hệ thống quản lý quan hệ khách hàng (CRM) của Salesforce.com.

Prerequisites

Bài viết này dành cho các nhà phát triển API. Nó chứa các bước chi tiết để tạo một ví dụ web API để thậm chí những người mới bắt đầu cũng có thể hoàn thành được. Tuy nhiên, nếu bạn có kiến thức về JavaScript Object Notation (JSON) và REST thì sẽ hiểu sâu hơn.

Để chạy được ví dụ trong bài này, bạn cần

  • Một vùng làm việc với một trình duyệt web tiêu chuẩn (Google Chrome 18 hoặc mới hơn, Mozilla Firefox 10 hoặc mới hơn, hay Internet Explorer® 9 hoặc mới hơn)
  • Một kết nối Internet
  • Một ID quản trị hợp lệ và quyền đăng nhập vào Cast Iron Web API (bạn có thể đăng ký dùng thử miễn phí)
  • Một tài khoản Salesforce.com hợp lệ và quyền đăng nhập (bạn có thể đăng ký một tài khoản phát triển).

Tạo và thử nghiệm các web API

Hãy tưởng tượng có một doanh nghiệp sử dụng Salesforce.com để lưu trữ thông tin CRM của họ, nhưng chỉ có nhân viên của công ty mới được truy cập vào nó. Doanh nghiệp muốn cung cấp một web API cho phép các nhà lập trình ứng dụng tạo ra một ứng dụng di động mới, nó có thể truy cập vào môi trường Salesforce.com. Ví dụ, họ có thể tạo ra một ứng dụng cho phép khách hàng bổ sung thêm thông tin liên lạc chi tiết của họ trực tiếp vào Salesforce.com nếu họ muốn được liên lạc với đại diện kinh doanh. Để kích hoạt chức năng này, bạn hãy thực hiện theo từng bước hướng dẫn được cung cấp trong bài viết này để tạo và thử nghiệm web API Salesforce.com, nơi cung cấp một nguồn tài nguyên được gọi là create_contact.

  1. Khởi động Cast Iron Web API Services bằng cách mở https://webapi.castiron.com trong trình duyệt.
  2. Chọn Sign In ở phía trên bên phải, nhập thông tin đăng ký của bạn vào trong của sổ, và chọn Sign In, giống như Hình 1.
    Hình 1. Đăng nhập Cast Iron Web API Services
    Hình ảnh đăng nhập vào Cast Iron Web API Services
  3. Ở trang Getting Started with Web API, chọn Create hoặc mục APIs ở đầu trang để tạo một API mới, giống như ở Hình 2.
    Hình 2. Tạo một API mới
    Hình ảnh tạo một API mới
  4. Trong hộp Create new API, nhập tên của API ví dụ như Salesforce.com, ngữ cảnh như salesforce, và mô tả như là API to expose Salesforce.com objects, giống như ở Hình 3Hình 4.


    Lưu ý rằng Uniform Resource Indicator (URI) cho API được hiển thị ở phần dưới cùng của hộp thoại Create new API. URL có định dạng:

    https://<company>.web.castiron.com/<context>,

    Ở đó <company> là tên công ty web API của bạn, và <context> là ngữ cảnh mà bạn đã điền vào lúc đầu.

    Chọn Create.

    Hình 3: Điền tên và mô tả của API
    Ảnh chỉ cách điền tên và mô tả của API
    Hình 4: Điền ngữ cảnh của API
    Ảnh chỉ cách điền ngữ cảnh của API

    Sau khi API được tạo, nó sẽ xuất hiện ở bên dưới hộp thoại Create new API .

  5. Chọn tên của API nếu muốn chỉnh sửa và thêm nguồn tài nguyên vào API, giống như ở Hình 5.
    Hình 5. Chỉnh sửa API bằng cách nhấp vào tên của nó.
    Ảnh chỉ cách chỉnh sửa API bằng cách nhấp vào tên của nó

    Có một sự lựa chọn thay thế là, chọn biểu tượng Pencil (bút chì) ở bên phải cửa sổ, giống như ở Hình 6.

    Hình 6. Hoặc là chỉnh sửa API bằng cách chọn biểu tượng Pencil (bút chì).
    Ảnh chỉ cách chỉnh sửa API bằng cách chọn biểu tượng Pencil (bút chì)
  6. Ở hộp thoại Add a Resource, lựa chọn hành động HTTP là POST, điền URL là create_contact, điền thông tin mô tả là Create a Salesforce.com contact, như được trình bày ở Hình 7.
    Hình 7. Điền thông tin nguồn tài nguyên chi tiết
    Ảnh chỉ cách điền thông tin nguồn tài nguyên chi tiết

    Lưu ý rằng URL cho nguồn tài nguyên được hiển thị bên dưới hộp thoại Add a Resource. URL có định dạng <API URI>/<resource URI>, ở đó <API URI> là URL cho API được bạn tạo ra trước đó, <resource URI> là URL bạn đã điền vào. Chọn Add.

    Sau khi nguồn tài nguyên được tạo, nó sẽ xuất hiện bên dưới hộp thoại Add a Resource

  7. Nhấp vào tên của tài nguyên để sửa đổi và bổ sung nó.
  8. Trong thẻ Resource Details, bạn có thể cấu hình các tham số, định dạng đầu và thân được yêu cầu, định dạng đầu và thân về cho tài nguyên. Nhập mã JSON trong Liệt kê 1 của vùng nội dung Request Body để xác định cấu trúc thân được yêu cầu mà bạn nên dùng cho tài nguyên này.

    Trong ví dụ này, chỉ có tên liên hệ, địa chỉ và địa chỉ thư điện tử là có sẵn để bạn có thể thiết lập thông qua API, nhưng bạn có thể bao gồm tất cả các trường trong đối tượng liên hệ Salesforce.com ở đây. Lưu ý là tài nguyên sẽ tự động lưu lại ngay khi bạn nhấp chuột ra khỏi vùng chữ.

    Liệt kê 1. Ví dụ về phần chủ thể yêu cầu trong định dạng JSON
    {
        "FirstName": "Katherine",
        "LastName": "Sanders",
        "Street": "IBM Hursley",
        "City": "Winchester",
        "County": "Hampshire",
        "Postcode": "SO21 2JN",
        "Country": "UK",
        "Email": "katherine_sanders@uk.ibm.com"
    }
  9. Nhập mã JSON trong Liệt kê 2 của vùng nội dung Response Body để xác định cấu trúc của phần thân mà tài nguyên sẽ trả về khi nó được gọi đến.

    Nếu việc tạo liên lạc Salesforce.com thành công, API trả về đối tượng ID, và giá trị trả về sẽ là true. Tuy nhiên, nếu có một lỗi xảy ra, giá trị trả về là false, và những trường bị lỗi sẽ được thiết lập thay cho ID.

    Liệt kê 2. Ví dụ phần thân trả về của định dạng JSON
    {
        "id": "003A0000016nDhJIAU",
        "success": "true",
        "error_field": "",
        "error_message": "",
        "error_code": ""
    }
  10. Nhấp vào thẻ Implement Resource, thể hiện trong Hình 8.

    Trong thẻ này, bạn định nghĩa việc thực thi tài nguyên bằng cách sử dụng một phương pháp hình thể. Bạn có thể truy cập đến cơ sở dữ liệu, Salesforce.com, và những API khác hoặc những dịch vụ có sẵn thông qua giao thức HTTP.

    Hình 8. Thực thi tài nguyên
    Hình ảnh cho biết làm thế nào để thực thi tài nguyên
  11. Nhấp vào ký hiệu dấu cộng (+) bên dưới mục Request trên phía trái của cửa sổ để thêm nguồn dữ liệu, như trong Hình 9.
    Hình 9. Thêm nguồn dữ liệu
    Hình ảnh cho biết làm thế nào để thêm nguồn dữ liệu
  12. Chọn Create objects bên dưới Salesforce.com trong bảng chọn để tạo một hoạt động yêu cầu mới.

    Bạn có thể tạo một hoặc nhiều hoạt động yêu cầu cho mỗi yêu cầu.

  13. Nhấp vào hoạt động yêu cầu để cấu hình nó, như trong Hình 10.
    Hình 10. Cấu hình hoạt động yêu cầu
    Hình ảnh cho biết làm thế nào để cấu hình hoạt động yêu cầu
  14. Nhập tên cho kết nối và các chứng nhận Salesforce.com của bạn, sau đó nhấp Connect, như trong Hình 11.

    Một thông báo trạng thái xuất hiện ở dưới cùng của cửa sổ giúp bạn nhận biết kết nối thành công. Các chứng nhận của bạn cũng có sẵn trong danh sách Existing Connections trên đầu, vì vậy sau này bạn sẽ không cần phải nhập lại lần nữa.

    Hình 11. Kết nối tới Salesforce.com
    Hình ảnh cho biết làm thế nào để kết nối tới Salesforce.com

    Bước khám phá của việc cấu hình nên được tải tự động sau khi kết nối thành công tới Salesforce.com. Cast Iron Web API tải danh sách của những đối tượng có sẵn từ môi trường Salesforce.com của bạn.

  15. Chọn đối tượng Contact, và chờ danh sách các trường có sẵn được tải lên trên phía phải của trang, như trong Hình 12.
    Hình 12. Chọn đối tượng liên hệ
    Hình ảnh cho biết làm thế nào để chọn đối tượng liên hệ
  16. Nhấp vào đường dẫn Clear All để xóa toàn bộ các mục đã chọn, sau đó chọn các trường bạn sẽ thiết lập với các giá trị từ chủ thể yêu cầu, như Hình 13.

    Trong ví dụ này, các trường được yêu cầu là FirstName, LastName (được chọn mặc định bởi vì đây là trường bắt buộc), MailingStreet, MailingCity, MailingState, MailingPostalCode, MailingCountry, và Email. Khi bạn hoàn thành, nhấp vào bước Configure trên cùng của trang.

    Hình 13. Chọn trường cần thiết lập từ đối tượng tạo sẵn
    Ảnh chỉ cách chọn trường cần thiết lập từ đối tượng tạo sẵn
  17. Bạn có thể dùng hai phương thức sau để ánh xạ (map) dữ liệu từ chủ thể yêu cầu đến các trường trong Salesforce.com trong đối tượng liên lạc mới. Phương thức Select Values được thực hiện trước, cho phép bạn chọn đường dẫn Select Available Value bên cạnh mỗi trường trong Salesforce.com và một giá trị trong chủ thể yêu cầu để sử dụng, như Hình 14.

    Chọn MAP VALUES ở góc trên bên phải để thực hiện phương thức thứ hai.

    Hình 14. Chọn giá trị cho từng trường
    Ảnh chỉ cách chọn giá trị cho từng trường
  18. Phương thức Map Values cho phép bạn ánh xạ các trường từ chủ thể yêu cầu đến các trường trong Salesforce.com trên giao diện đồ họa. Kéo vòng tròn bên cạnh mỗi trường yêu cầu đến trường tương ứng bên Saleforce.com trong Bảng 1, như Hình 15.

    Một cách khác để thực hiện ánh xạ là bạn có thể áp dụng một hàm cho mỗi ánh xạ bằng cách nhấn vào dấu cộng trên mỗi đường nối giữa các trường. Danh sách các hàm có sẵn trong tài liệu sản phẩm Cast Iron Express (xem đường dẫn ở phần Tài nguyên).

    Hình 15. Ánh xạ dữ liệu cho từng trường
    Ảnh của cách ánh xạ dữ liệu cho từng trường
Bảng 1: Yêu cầu ánh xạ
Trường của chủ thể yêu cầuTrường liên lạc của Salesforce.com
FirstNameFirstName
LastNameLastName
StreetMailingStreet
CityMailingCity
CountyMailingState
PostcodeMailingPostalCode
CountryMailingCountry
EmailEmail
  1. Nhấn vào nút Select Values góc trên bên phải để trở về phương thức thứ nhất nếu các bạn muốn xem phiên bản bằng chữ của các ánh xạ. Xem Hình 16.

    Các trường của Salesforce.com hiện bên trái, và các trường trong chủ thể yêu cầu hiện bên phải.

    Hình 16: Thể hiện phiên bản chữ của các ánh xạ
    Ảnh chỉ cách hiển thị phiên bản chữ của ánh xạ
  2. Nhấp vào nút Response bên góc trái của trang, sau đó chọn MAP VALUES ở bên phải. Hoàn thành việc ánh xạ trong Bảng 2 từ các trường phản hồi của Salesforce.com đến các trường trong chủ thể phản hồi cho tài nguyên, như hiển thị trong Hình 17.

    Chú ý, ánh xạ của trường success được tô màu, bởi vì kiểu dữ liệu của chúng không khớp nhau. Bạn có thể bỏ qua cảnh báo, bởi vì kiểu dữ liệu Boolean của trường success trong Salesforce.com sẽ được tự động chuyển đổi sang kiểu string (chuỗi) tương ứng của trường success trong chủ thể phản hồi. Để biết thêm thông tin về định nghĩa các ánh xạ, xem ở phầnTài nguyên.

    Hình 17. Ánh xạ chủ thể phản hồi
    Ảnh hiển thị ánh xã phản hồi của chủ thể
Bảng 2: Ánh xạ phản hồi
Trường phản hồi của Salesforce.comTrường của chủ thể phản hồi
results/result/errors/fieldserror_field
results/result/errors/messageerror_message
results/result/errors/statusCodeerror_code
results/result/idid
results/result/successsuccess

Bạn đã hoàn thành việc cài đặt một nguồn có thể tạo ra một liên lạc trên Salesforce.com bằng cách sử dụng thông tin được gửi trong chủ thể yêu cầu. Nguồn trả về một chủ thể phản hồi với một trong hai giá trị: ID contact hoặc chi tiết lỗi nếu việc tạo liên lạc không thành công. Tuy nhiên, trước khi bạn có thể kiểm tra nguồn, bạn phải tạo một entitlement.

Với mỗi web API, bạn có thể định nghĩa đến ba mức entitlement của API. Các entitlement này phản ánh các ánh mức độ khác nhau của việc sử dụng, bảo mật, và giá cả. Nhấp vào liên kết Salesforce.com nằm trên cùng của trang để trở về trang cấu hình API, sau đó nhấp vào tab Entitlements. Trong hộp Add an Entitlement:

  1. Nhập tên Entitlement, ví dụ Basic.
  2. Nhập mô tả, ví dụ Basic entitlement.
  3. Nhập cấp bảo mật Requires Id.
  4. Nhập số lần gọi trên một phút 10.

Cuối cùng, nhấp vào Add (xem Hình 18).

Hình 18. Nhập tên, mô tả, số lần gọi trên một phút cho Entitlement
Ảnh chỉ cách nhập tên, mô tả, số lần gọi trên một phút cho Entitlement

Sau khi entitlement được tạo, nó sẽ xuất hiện bên dưới khung Add an Entitlement. Bạn cũng cần phải kích hoạt nguồn trước khi kiểm tra nó. Nhấp vào thẻ Resource Definition ở đầu trang, sau đó nhấp vào biểu tượng Play cạnh create_contacts để bắt đầu.

Một cửa sổ thông tin sẽ xuất hiện, trạng thái thể hiện rằng nguồn đã được kích hoạt thành công. Nhấp OK. Bây giờ, bạn có thể bắt đầu kiểm tra nguồn.


Thử nghiệm

Để thử nghiệm nguồn tài nguyên vừa tạo, hoàn thành các bước sau:

  1. Nhấp vào thẻ Test, và sau đó chọn nguồn create_contact từ danh sách Resource, thể hiện như trong Hình 19.

    Thao tác trên sẽ tải các chủ thể yêu cầu ví dụ từ Liệt kê 1 mà bạn sử dụng trong cấu hình tài nguyên.

    Hình 19. Chọn nguồn để thử nghiệm
    Ảnh chỉ cách chọn tài nguyên để thử nghiệm
  2. Chọn Test application từ danh sách Application, và sau đó nhấp Test, thể hiện như trong Hình 20. Ứng dụng này được cung cấp để cho phép bạn thử nghiệm tài nguyên của bạn mà không cần phải tạo ra một ứng dụng trước.
    Hình 20. Chọn ứng dụng thử nghiệm
    Ảnh chỉ cách chọn ứng dụng thử nghiệm
  3. Chờ cho phản hồi xuất hiện ở nửa dưới màn hình, như hiển thị ở Hình 21.

    Bạn biết rằng các yêu cầu đã hoàn thành bởi vì trường error trống, và trường success là "true", và trường ID chứa ID của thông tin liên lạc được tạo ra trong Salesforce.com.

    Hình 21. Một phản hồi thành công
    Ảnh hiển thị một phản hồi thành công

    Bây giờ, hãy kiểm tra một trường hợp lỗi để đảm bảo rằng các trường lỗi hoạt động một cách chính xác.

  4. Thay đổi LastName trong chủ thể yêu cầu thành "", sau đó nhấp Test.

    Theo dự kiến, một lỗi được trả lại trong phần phản hồi, bởi vì trường LastName là bắt buộc trong Salesforce.com; ID rỗng, vì việc tạo bị thất bại, như thể hiện trong Hình 22.

    Hình 22. Chủ thể phản hồi lỗi
    Ảnh hiển thị lỗi phản hồi của chủ thể

Kết Luận

Bài viết này thể hiện cách tạo ra một trang web API Salesforce.com sử dụng Cast Iron Web API. Nó cho thấy cách tiếp xúc với một nguồn tài nguyên được gọi là create_contact trong API và làm thế nào để kiểm tra các nguồn tài nguyên bằng cách gửi hai yêu cầu HTTP POST đến nó. Yêu cầu đầu tiên tạo thành công một liên lạc Salesforce.com và trả lại ID. Yêu cầu thứ hai thất bại và trả lại các chi tiết lỗi thay vì ID như mong đợi.

Khi một API đã sẵn sàng để phát hành cho cộng đồng phát triển, bạn nên công khai bằng cách nhấn vào Public ở phía trên bên phải của trang cấu hình API. Làm như vậy sẽ giúp cho các API có thể được nhìn thấy trong các cổng thông tin phát triển. Bạn có thể truy cập cổng thông tin phát triển của bạn bằng cách thực hiện theo các bước trong tài liệu Web API.

Bạn cũng nên tùy chỉnh các cổng thông tin phát triển để phù hợp với xây dựng thương hiệu công ty của bạn. Các trang này rất quan trọng, bởi vì chúng được nhìn thấy bởi người dùng bên ngoài, họ công bố công ty của bạn, và họ là chìa khóa trong việc tạo ra các cơ hội kinh doanh mới. Để truy cập vào cấu hình này, nhấp vào tên người dùng của bạn ở phía trên bên phải của trang, và sau đó chọn tùy chọn Customize Developer Pages trong menu xuất hiện. Xem tài liệu web API để biết thêm thông tin.

Sau khi các nhà phát triển đã bắt đầu sử dụng các web API của bạn, bạn cũng có thể theo dõi các nhà phát triển ứng dụng và yêu cầu được hưởng cũng như phân tích lưu lượng API.

Tài nguyên

Học tập

Lấy sản phẩm và công nghệ

Thảo luận

  • Theo dõi Cast Iron Web API trên Twitter tại @ibmapimgt.

Bình luận

developerWorks: Đăng nhập

Các trường được đánh dấu hoa thị là bắt buộc (*).


Bạn cần một ID của IBM?
Bạn quên định danh?


Bạn quên mật khẩu?
Đổi mật khẩu

Bằng việc nhấn Gửi, bạn đã đồng ý với các điều khoản sử dụng developerWorks Điều khoản sử dụng.

 


Ở lần bạn đăng nhập đầu tiên vào trang developerWorks, một hồ sơ cá nhân của bạn được tạo ra. Thông tin trong bản hồ sơ này (tên bạn, nước/vùng lãnh thổ, và tên cơ quan) sẽ được trưng ra cho mọi người và sẽ đi cùng các nội dung mà bạn đăng, trừ khi bạn chọn việc ẩn tên cơ quan của bạn. Bạn có thể cập nhật tài khoản trên trang IBM bất cứ khi nào.

Thông tin gửi đi được đảm bảo an toàn.

Chọn tên hiển thị của bạn



Lần đầu tiên bạn đăng nhập vào trang developerWorks, một bản trích ngang được tạo ra cho bạn, bạn cần phải chọn một tên để hiển thị. Tên hiển thị của bạn sẽ đi kèm theo các nội dung mà bạn đăng tải trên developerWorks.

Tên hiển thị cần có từ 3 đến 30 ký tự. Tên xuất hiện của bạn phải là duy nhất trên trang Cộng đồng developerWorks và vì lí do an ninh nó không phải là địa chỉ email của bạn.

Các trường được đánh dấu hoa thị là bắt buộc (*).

(Tên hiển thị cần có từ 3 đến 30 ký tự)

Bằng việc nhấn Gửi, bạn đã đồng ý với các điều khoản sử dụng developerWorks Điều khoản sử dụng.

 


Thông tin gửi đi được đảm bảo an toàn.


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=70
Zone=Cloud computing
ArticleID=944942
ArticleTitle=Xây dựng một Web API để tiếp xúc với các đối tượng của Salesforce.com
publish-date=09122013