Kết nối API

Cho phép các ứng dụng bên ngoài kết nối và thao tác với các đối tượng dữ liệu của SlimCRM

Tạo Api Token

API Token là chuỗi mã hóa chứa thông tin truy cập api, có thời gian hết hạn xác định bởi người tạo

• Truy cập [ Hệ thống ] > [ Cài đặt ] > [ Quản lý API ]

• Bấm nút [ Thêm tài khoản ] để tạo token mới

• Lưu ý: mỗi token sẽ có thời gian hết hạn xác định

• Nếu bạn không tìm thấy mục [ Quản lý API ] thì hãy yêu cầu bộ phận hỗ trợ của SlimCRM kích hoạt tính năng API bởi mặc định tính năng này bị tắt

(Tạo API token mới)

Cách sử dụng API

Chi tiết danh sách các API được liệt kê bên dưới Giả sử bạn đã tạo token jEheVytlAoFl7F8MqUQ7jAo2hOXASztXj và bạn cần lấy về danh sách tất cả các KHÁCH HÀNG của SlimCRM, hãy sử dụng API thông qua cURL request như sau

curl -H "authtoken: jEheVytlAoFl7F8MqUQ7jAo2hOXASztXj" https://crm.slimsoft.vn/demo/api/customers

Bạn có thể sử dụng http://postman.com để test và tìm hiểu nhanh các API mà không cần viết code

1. Khách hàng

Tìm kiếm thông tin khách hàng theo keyword

GET [url]/api/customers/search/:keyseach

Keysearch: có thể là tên, số điện thoại, email...

Headers

Name	Type	Description
authtoken*	String

200: OK Customer object

{
    // Response
}

Thêm mới khách hàng

POST [url]/api/customers

Headers

Name	Type	Description
authtoken	string	Api token

Request Body

Name	Type	Description
company	string	Tên công ty
vat	string	Mã số thuế VAT
phonenumber	string	Số điện thoại
website	string	Website
address	string	Địa chỉ
city	string	Khu vực
	String

200

HTTP/1.1 200 OK
{
  "status": true,
  "message": "Customer add successful."
}

HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Customer add fail."
}

Cập nhật thông tin khách hàng

PUT [url]/api/customers/:id

Headers

Name	Type	Description
authtoken*	String	Api token

Request Body

Name	Type	Description
company*	String	Mandatory Customer company
optionalvat	String	Vat
phonenumber	String	Customer Phone
website	String	Customer Website
groups_in	Number	Customer groups
default_language	String	Customer Default Language
default_currency	String
address	String
billing_street	String
billing_country	String
shipping_street	String
	String

200: OK

{ 
 "company": "Tên công ty", 
 "vat": "", 
 "phonenumber": "0123456789", 
 "website": "", 
 "default_language": "", 
 "default_currency": "0", 
 "country": "243", 
 "city": "TP HN", 
 "zip": "700000", 
 "state": "", 
 "address": "Ngõ 14", 
 "billing_street": "Nguyễn Trãi", 
 "billing_city": "TP Hà Nội", 
 "billing_state": "Quận HĐ", 
 "billing_zip": "700000", 
 "billing_country": "243", 
 "shipping_street": "", 
 "shipping_city": "", 
 "shipping_state": "", 
 "shipping_zip": "", 
 "shipping_country": "0" 
} 

Xóa thông tin khách hàng

DELETE [url]/api/delete/customers/:id

Headers

Name	Type	Description
authtoken*	String

Request Body

Name	Type	Description
id*	Number	Customer unique ID

Lấy về thông tin khách hàng

GET [url]/api/customers/:id

Headers

Name	Type	Description
authtoken*	String

Request Body

Name	Type	Description
id*	Number	customer unique ID

2. Cơ hội

Tìm kiếm thông tin "Cơ hội" theo keyword

GET [url]/api/leads/:keysearch

Keyseach: có thể là tên, email, số điện thoại

Headers

Name	Type	Description
authtoken	String

200: OK Lead Object

{
    // Response
}

Thêm mới cơ hội

POST [url]/api/leads

Headers

Name	Type	Description
authtoken	string	Api token

Request Body

Name	Type	Description
source	string	Nguồn cơ hội
status	string	Tình trạng cơ hội
name	string	Tên cơ hội
assigned	string	ID người phụ trách
tags	string	Gắn nhãn
title	string	Chức vụ
email	string	Địa chỉ email
website	string	Website
phonenumber	string	Số điện thoại
company	string	Tên công ty
address	string	Địa chỉ
city	string	Khu vực
description	string	Mô tả
contacted_today	string	Đã liên hệ
is_public	string	Công khai, tất cả đều được xem

200

HTTP/1.1 200 OK
{
  "status": true,
  "message": "Lead add successful."
}

HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Lead add fail."
}

Lấy thông tin cơ hội

GET [url]/api/leads/:id

Path Parameters

Name	Type	Description
id	string	ID của "Cơ hội"

Headers

Name	Type	Description
authtoken	string	API token

200

HTTP/1.1 200 OK
{
    "id": "17",
    "hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
    "name": "Lead name",
    "contact": "",
    "title": "",
    "company": "Themesic Interactive",
    "description": "",
    "country": "243",
    "zip": null,
    "city": "London",
    "state": "London",
    "address": "1a The Alexander Suite Silk Point",
    "assigned": "5",
    "dateadded": "2019-07-18 08:59:28",
    "from_form_id": "0",
    "status": "0",
    "source": "4",
    ...
}

404

HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "No data were found"
}

3. Dự án

→ Thêm mới Dự án → Xóa Dự án → Yêu cầu thông tin về Dự án → Tìm kiếm thông tin Dự án → Sửa thông tin Dự án

4. Nhân viên

→ Thêm mới Nhân viên → Xóa Nhân viên → Yêu cầu thông tin Nhân viên → Tìm kiếm thông tin Nhân viên → Sửa thông tin Nhân viên

5. Công việc

→ Thêm mới Công việc → Xóa Công việc → Yêu cầu thông tin về Công việc → Tìm kiếm thông tin Công việc → Sửa thông tin Công việc

6. Yêu cầu hỗ trợ (tickets)

→ Thêm mới Yêu cầu → Xóa Yêu cầu → Yêu cầu thông tin → Tìm kiếm thông tin về Yêu cầu hỗ trợ → Sửa thông tin về Yêu cầu hỗ trợ

Tải về tài liệu API đầy đủ