Thông tin môi trường API

Mô tả và thông tin API

Môi trường thực tế (Production): https://apiehd.smartsign.com.vn

Mô tả: Môi trường thực tế là môi trường mà hệ thống được sử dụng để cung cấp dịch vụ cho người dùng cuối.

Môi trường thử nghiệm (Sandbox): https://demo-apiehd.smartsign.com.vn

Mô tả: Môi trường thử nghiệm là môi trường được sử dụng để thử nghiệm các thay đổi đối với hệ thống trước khi triển khai chúng vào môi trường thực tế.

Hướng dẫn sử dụng header Authorization cho các yêu cầu API:

Header Authorization là một header HTTP được sử dụng để xác thực mã thông báo của người dùng khi họ thực hiện yêu cầu đến API. Mã thông báo này được cấp bởi hệ thống quản lý xác thực và cho phép người dùng truy cập vào các tài nguyên được bảo vệ.:

Ngoại trừ API Xác thực tài khoản. Tất cả các request đến API đều yêu cầu token trong header (bao gồm tất cả các methods: GET, POST, PUT...).:

Để tạo header Authorization, bạn cần thực hiện các bước sau::

  1. Tạo một header mới có tên là "Authorization".
  2. Đặt giá trị của header thành "Token [access_token]".
  3. Thay thế [access_token] bằng mã thông báo (Access Token) của bạn.
  4. Thêm header vào yêu cầu của bạn.

Ví dụ: nếu mã thông báo của bạn là "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", thì header của bạn sẽ trông như thế này:

Authorization: Token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Cách thêm header Authorization vào yêu cầu

Bạn có thể thêm header Authorization vào yêu cầu của mình bằng cách sử dụng ngôn ngữ lập trình yêu thích của mình. Ví dụ: trong C#, bạn có thể sử dụng mã sau: 


var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://apiehd.smartsign.com.vn/api/...");
request.Headers.Add("Authorization", "Token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...");

Cách sử dụng header Authorization

Sau khi bạn đã thêm header Authorization vào yêu cầu của mình, bạn có thể gửi yêu cầu đến API. API sẽ xác thực mã thông báo của bạn và trả về phản hồi.

Lưu ý:
  • Mã thông báo Authorization phải được giữ bí mật. Nếu mã thông báo bị lộ, bất kỳ ai cũng có thể sử dụng nó để truy cập vào các tài nguyên của bạn.:
  • Mã thông báo Authorization có thời hạn sử dụng. Bạn có thể làm mới Access Token để tiếp tục sử dụng các API.:

Mã nguồn ví dụ:

							
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://apiehd.smartsign.com.vn/api/...");
request.Headers.Add("Authorization", "Token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...");
						
							
var settings = {
"url": "https://apiehd.smartsign.com.vn/api/...",
"method": "POST",
"timeout": 0,
"headers": {
"Authorization": "Token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"Content-Type": "application/json"
}, ...
							
							
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://apiehd.smartsign.com.vn/api/...',
'headers': {
'Authorization': 'Token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
'Content-Type': 'application/json'
}, ...