Acheckin-hrm-sdk NPM

ACheckin SDK

Giới thiệu ACheckin SDK

Mục lục

Yêu cầu
Cài đặt
Chạy trên ACheckin
Phát triển ứng dụng
Phát hành
API Reference

📋 Yêu cầu

Ứng dụng ACheckin HRM: https://dev.acheckin.io/
NodeJS & NPM (khuyên dùng) hoặc
dự án Web có thể chạy độc lập không cần cài đặt lên server

🛠 Cài đặt

Chúng tôi hỗ trợ nhà phát triển có thể tạo mới một ứng dụng chạy trên nền tảng ACheckin với nhiều cách khác nhau. Hãy lựa chọn một phương án mà bạn yêu thích.

🚀 Bắt đầu một dự án mới (khuyên dùng)

Bạn có thể khởi tạo một ứng dụng mới hoàn toàn bằng công cụ ACheckin CLI do chúng tôi cung cấp.

Chú ý: ứng dụng được viết trên nền ReactJS.

Cài đặt CLI
npm install acheckin-hrm -global
Tạo dự án mới
acheckin-hrm init MyMiniApp acheckin-hrm init MyMiniApp --id com.example.miniapp --template ts
Cú pháp
- --template [js|ts|html] tạo project theo template javascript react (defaul) | typescript react | html
- --id [your_bundle_id] cài đặt app ID
Chúc mừng, bạn đã khởi tạo thành công!
Nhập lệnh cd MyMiniApp && acheckin-hrm run và dùng ACheckin trên điện thoại quét mã QR được tạo trên Terminal.

📚 Thêm ACheckin SDK vào dự án NPM / Yarn-supported có sẵn

ACheckin SDK có thể được cài đặt như một thư viện cho các dự án dùng npm / yarn.

Bạn có thể cài đặt bằng cú pháp

npm install acheckin-hrm-sdk hoặc
yarn add acheckin-hrm-sdk

Sau đó, tạo file config.json ở thư mục public của dự án mà bạn có thể xem với url http://your-ip-address/config.json

{
	"app_name": "tên-app-của-bạn",
	"app_id": "acheckin.miniapp.template",
	"version": "0.0.1",
	"main": "index.html",
}

🔖 Thêm ACheckin SDK như một thư viện JS

Sẽ cập nhật sớm

📱 Khởi chạy ứng dụng

Đối với ứng dụng tạo bằng ACheckin CLI

Thật đơn giản, hãy chạy cú pháp acheckin-hrm run và dùng ACheckin quét mã QR.

Với các ứng dụng khác

chạy webserver môi trường dev
tạo mã QR code với định dạng acheckin://app_dev?h=[your_ip_address]&p=[port] và quét mã này bằng ACheckin
sử dụng ACheckin CLI với cú pháp acheckin-hrm qr

⌨️ Phát triển ứng dụng

Import ACheckin HRM SDK vào dự án

import { ACheckinSDK } from "acheckin-hrm-sdk";

Khởi tạo SDK

window.asyncACheckinInit = async () => {
	ACheckinSDK.init();
};

Lấy các thông tin người dùng

try {
	// Access token
	const accessToken = await ACheckinSDK.getAccessToken();

	// lấy thông tin người dùng (public)
	const userInfo = await ACheckinSDK.getUserPersonalInfo();
	// lấy thông tin người dùng (trong workspace)
	const userInfo = await ACheckinSDK.getUserWorkspaceInfo();
} catch (e) {}

Chúc mừng, bạn đã lấy được thông tin cơ bản của người dùng.

Hãy Quét mã QR trên ACheckin nhé!

Chạy ứng dụng trên Chrome

ACheckin hỗ trợ nhà phát triển có thể test ứng dụng trực tiếp trên trình duyệt với Chrome Extension. Bạn có thể cài đặt bản Beta bằng cách sau

Tải ACheckin Mini App Emulator tại đây
Giải nén và xem hướng dẫn tại đây
Chạy ứng dụng acheckin run và chọn biểu tượng ACheckin trên trình duyệt

Xem ảnh lớn hơn

ACheckin Emulator

🎉 Phát hành ứng dụng

Coming Soon

📖 API Reference

getAccessToken() -> Promise<string> - lấy accesstoken
getUserPersonalInfo() -> Promise<UserPersonalInfo> - lấy thông tin user public (personal)

interface UserPersonalInfo {
	avatar: string;
	id: string;
	language: string;
	name: string;
	username: string;
	phone_number: string;
}

getUserWorkspaceInfo() -> Promise<UserWorkspaceInfo> - lấy thông tin user trong workspace

interface UserWorkspaceInfo {
	id: string;
	name: string;
	email: string;
	birthday: string;
	gender: "F" | "M";
	is_owner: boolean;
	is_leader: boolean;
	current_workspace: string;
}

setItem(key: string, value: string) -> Promise<boolean> - lưu string vào bộ nhớ theo key
getItem(key: string) -> Promise<string> - lấy value theo key
getDeviceInfo(Array<keyof DeviceInfo>) -> Promise<DeviceInfo> - thông tin thiết bị

interface DeviceInfo {
	device_id: string;
	device_name: string;
	device_platform: string;
	bundle_id: string;
	device_os_version: string;
	is_tablet: boolean;
	ip_address: string;
	battery_level: number;
	battery_changing: boolean;
	device_mac_address: string;
	device_manufacturer: string;
	device_brand: string;
	wifi_name: string;
	is_wifi: boolean;
	has_network: string;
	is_mobile_data: boolean;
}

readBarCode() -> Promise<string> - đọc QR / bar code
addShakeEventListener(callback) - xử lý event lắc thiết bị
isCheckedIn -> Promise<boolean> - kiểm tra user đã checkin vào workspace hay chưa
getCurrentLocation -> Promise<Location> - lấy vị trí hiện tại của user

interface Location {
	latitude: number;
	longitude: number;
}

shareScreen(string) - chụp màn hình và chia sẻ với message tùy chọn
setLocalNotification({title, body, schedule_time: number}) - tạo và lên lịch hiển thị local notification
vibrate - rung thiết bị