API

Wave đi kèm với một API sẵn có, cho phép bạn cung cấp một API cho người dùng của mình hoặc xây dựng một ứng dụng di động từ API của bạn.

Trong phần này, chúng tôi sẽ đi sâu hơn về cách bạn có thể sử dụng Wave API.


Truy cập dữ liệu từ API

Để truy cập dữ liệu từ API, người dùng hoặc một ứng dụng sẽ cần phải chuyển Mã truy cập cho API. Mã thông báo truy cập này sẽ xác định loại dữ liệu nào có thể được truy cập hoặc trả về.

Có 2 cách để nhận Mã thông báo truy cập:

  1. Bạn có thể yêu cầu Mã truy cập từ khóa API.
  2. Bạn có thể yêu cầu Mã truy cập bằng email và mật khẩu.

Nhận mã thông báo truy cập từ khóa API

Để tạo khóa API, bạn có thể truy cập trang cài đặt API của mình tại:/settings/api , sau đó để tạo khóa API mới, hãy nhập tên vào hộp văn bản và nhấp vàoCreate New Key cái nút.

ảnh chụp màn hình api 1

Sau khi tạo khóa API mới, bạn sẽ thấy nó trong danh sách Khóa API hiện tại. Bạn sẽ có thể thấy Tên, Ngày tạo và Lần sử dụng cuối cùng. Ngoài ra, bạn có thể thực hiện 3 hành động với Khóa API mới này. Để xem Khóa API hiện tại. Bấm vàoView cái nút:

ảnh chụp màn hình api 2

Và bạn sẽ thấy khóa API hiện tại, nơi bạn có thể sao chép và dán nó để sử dụng.

ảnh chụp màn hình api 3

Tiếp theo, bạn có thể nhấp vàoEdit cái nút:

ảnh chụp màn hình api 4

Nơi bạn sẽ có thể chỉnh sửa tên khóa API hiện tại.

ảnh chụp màn hình api 5

Cuối cùng, nếu bạn nhấp vào nút xóa:

ảnh chụp màn hình api 6

Bạn sẽ có thể xóa khóa API hiện tại.

ảnh chụp màn hình api 7

Tiếp theo, hãy chuyển sang tìm hiểu cách bạn có thể sử dụng khóa API này để yêu cầu Mã thông báo truy cập từ API. Sau khi chúng tôi nhận được Mã thông báo truy cập, chúng tôi có thể sử dụng mã đó để truy xuất dữ liệu từ ứng dụng của mình.

Để yêu cầu Mã thông báo truy cập, chúng tôi có thể gửi yêu cầu ĐĂNG tới:

/api/token?key=API_KEY_HERE

Và bạn sẽ nhận được một phản hồi tương tự như sau:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC93YXZlLnRlc3RcL2FwaVwvdG9rZW4iLCJpYXQiOjE1Mzk4MDg4OTUsImV4cCI6MTUzOTgxMjQ5NSwibmJmIjoxNTM5ODA4ODk1LCJqdGkiOiJRdTViYnhwdlBkNE9tT3ZZIiwic3ViIjoyLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.AJNTXTlnI74ZyPw2rqvEaI7P5YPaLnZNWcCBBmRX0W0"
}

Đây là Mã truy cập mà chúng tôi sẽ sử dụng để truy xuất dữ liệu trong ứng dụng của mình. Chúng tôi sẽ hướng dẫn bạn cách sử dụng Mã thông báo truy cập này trong vài bước tiếp theo.

Nhận Mã truy cập từ Đăng nhập

Để nhận Mã truy cập từ Đăng nhập người dùng, bạn có thể thực hiện yêu cầu ĐĂNG để:

/api/[email protected]&password=password

Và bạn sẽ nhận được phản hồi tương tự như phản hồi ở trên:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC93YXZlLnRlc3RcL2FwaVwvbG9naW4iLCJpYXQiOjE1Mzk4MTE0NjUsImV4cCI6MTUzOTgxNTA2NSwibmJmIjoxNTM5ODExNDY1LCJqdGkiOiJKRWljOGdTWFp4S0VjaWh1Iiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0._1oFRK-zeUKMpvCcg8kmM86avzzmI--yQnI4KRwYk1k",
    "token_type": "bearer",
    "expires_in": 60
}

Bạn sẽ thấy rằng phản hồi này bao gồm thêm 2 trường nữa là tokentype và expiresin. Khi ứng dụng của bạn phát hiện mã thông báo truy cập đã hết hạn, nó sẽ cần yêu cầu mã thông báo truy cập mới với yêu cầu API sau:

PHƯƠNG PHÁP URI Người mang TOKEN
BÀI ĐĂNG /api/refresh Người mang: eyJ0e ...

Và bạn sẽ nhận được Mã thông báo truy cập mới để ứng dụng của bạn được sử dụng. Mã thông báo hết hạn và làm mới này là phổ biến để giữ an toàn cho API của bạn.

Yêu cầu Dữ liệu bằng Mã truy cập

Bây giờ, bạn có Mã thông báo truy cập, bạn có thể yêu cầu dữ liệu từ ứng dụng bằng mã thông báo đó. Dựa trên sự cho phép của người dùng hiện tại, họ sẽ có thể Duyệt, Đọc, Chỉnh sửa, Thêm và Xóa bất kỳ nội dung nào trong ứng dụng của bạn.

Lấy ví dụ về các bài đăng trên blog, người dùng có thể truy xuất dữ liệu bằng cách sử dụng các tuyến an toàn sau:

CÁC LOẠI PHƯƠNG PHÁP URI Người mang TOKEN
JSON GET (Duyệt) /api/posts Người mang: eyJ0e ...

Trong các phương thức PUT và POST ở trên, bạn có thể chuyển dữ liệu JSON để Chỉnh sửa hoặc Thêm nội dung.

Kiểm tra API của bạn

Bạn có thể kiểm tra ứng dụng của mình bằng cách sử dụng công cụ của bên thứ ba có tên là Ins mất ngủ , đây là một ứng dụng miễn phí mà bạn có thể tải xuống và bạn có thể xem tất cả các điểm cuối ở bên trái và dữ liệu API ở bên phải.

ảnh chụp màn hình api 8

Để tải xuống các Điểm kết thúc cho ứng dụng Wave, bạn có thể tìm thấy tệp này ở đây:https://github.com/thedevdojo/laravel-wave-api-endpoints , trang này cũng hiển thị hướng dẫn về cách nhập các điểm cuối hiện tại.

Sau khi bạn đã nhập các điểm cuối API, bạn cũng có thể muốn thay đổi biến BASE_URL trong ứng dụng. Chúng tôi sử dụnghttps://wave.test để thử nghiệm, nhưng URL cục bộ của bạn có thể khác. Để thực hiện việc này, bạn cần nhấp vào Phát triển-> Quản lý môi trường

ảnh chụp màn hình api 9

Sau đó, bạn sẽ cần thay đổibase_url giá trị cho URL ứng dụng của bạn.

ảnh chụp màn hình api 10

Và, bây giờ bạn đã sẵn sàng để kiểm tra API của mình.

Đăng ký qua API

Nếu bạn đang tạo một API, bạn cũng có thể muốn cho phép người dùng của mình đăng ký. Điều này cũng đơn giản. Bạn có thể thực hiện yêu cầu ĐĂNG để:

/api/register?name=John Doe&username=jdoe&[email protected]&password=pass

Và một người dùng mới sẽ được đăng ký và được cấp Mã truy cập để truy cập dữ liệu thông qua API của bạn.