Thiết lập cơ bản

Trước khi bắt đầu sử dụng Goship API, bạn sẽ cần phải có:

  • Tài khoản Goship.io: Dùng để quản lý thông tin vận chuyển trên phần mềm Goship.io
  • Access Token: Dùng để tương tác với hệ thống Goship API

Đăng ký tài khoản Goship

Tài khoản Goship cho phép bạn truy cập vào hệ thống quản lý đơn hàng của Goship. Chúng ta cũng sử dụng hệ thống này cho mục đích testing khi thực hiện kết nối đẩy đơn hàng.

Lưu ý

Do tài khoản developer trên môi trường Production luôn inactive (do chưa có hợp đồng dịch vụ giữa 2 bên) nên xuyên suốt trong tài liệu này, các thông tin được đề cập tới đều là môi trường Sandbox.

Link đăng ký tài khoản: https://dev-shop.goship.io/. Điền đẩy đủ các thông tin trên form đăng ký và submit.

Goship register

Access Token

Có 2 cách để lấy được access token trên Goship. Đầu tiên, bạn cần truy cập menu Cài đặt > Kết nối API trên phần mềm quản lý vận đơn Goship.io:

Tài khoản developer Goship API

Lấy Access Token trực tiếp:

Tài khoản developer Goship API

Access token này phù hợp với các hệ thống cần tích hợp giao hàng đơn giản, không có xử lý webhook. Hoặc nếu 1 bên phần mềm thứ 3 đã tích hợp sẵn Goship thì bạn chỉ cần thêm token này vào hệ thống của bên thứ 3. Thời gian tồn tại của access token là rất dài, bạn sẽ không cần phải lo thao tác refresh token.

Sử dụng tài khoản developer:

Để tạo tài khoản developer, tại mục Goship API Account click nút Generate. Hệ thống sẽ tự động sinh thông tin Client IDClient Secret. Đây là 2 trường thông tin mà bạn cần để login vào hệ thống Goship API.

Bạn có thể xem cách lấy Access Token bằng tài khoản Developer tại mục Authentication

Môi trường phát triển tích hợp

Sandbox:

  • Quản lý vận đơn: http://dev-shop.goship.io
  • API endpoint: http://sandbox.goship.io/api/v2

Production:

  • Quản lý vận đơn: https://shop.goship.io
  • API endpoint: https://api.goship.io/api/v2
Lưu ý
  • Production urls sử dụng giao thức https.
  • Tài khoản developer trên môi trường production sẽ không được mặc định kích hoạt. Vui lòng liên hệ email [email protected] để được hỗ trợ thêm.

Testing

Bạn nên sử dụng Postman hoặc Insomnia Rest để thực hiện testing các API trong tài liệu.

Edit this page on GitHub Updated at Tue, Mar 29, 2022