Giới thiệu
Chào mừng bạn đến với tài liệu tham khảo API Mailtarget. Hãy làm theo hướng dẫn này để bắt đầu.
API Mailtarget được xây dựng trên giao thức HTTP. API của chúng tôi tuân theo kiến trúc RESTful và có các đặc điểm sau:
Sử dụng các URL có cấu trúc và nhất quán, dễ dàng dự đoán.
Tận dụng các khả năng vốn có của HTTP cho việc truyền tham số và xác thực.
Sử dụng mã phản hồi HTTP chuẩn để chỉ ra lỗi.
Cung cấp phản hồi dưới định dạng JSON.
Mailtarget cung cấp thư viện cho nhiều ngôn ngữ lập trình khác nhau. Bạn có thể chọn sử dụng các thư viện của chúng tôi hoặc sử dụng bất kỳ thư viện HTTP/REST nào tương thích với ngôn ngữ lập trình của bạn để thực hiện yêu cầu HTTP tới Mailtarget. Chúng tôi khuyến khích bạn truy cập trang thư viện của chúng tôi, nơi cung cấp các gợi ý về các thư viện HTTP REST.
Điểm cuối (Endpoints)
Tất cả các yêu cầu đến API cần bắt đầu với URL cơ sở thích hợp:
Mailtarget production
https://transmission.mailtarget.co/v1
Xác thực (Authentication)
Xác thực mỗi yêu cầu bằng cách thiết lập tiêu đề Authorization với một API key hợp lệ.
Chúng tôi chấp nhận các API key sau trong môi trường sandbox:
"Authorization": provided in sandbox dashboard
Chúng tôi chấp nhận các API key sau trong môi trường production:
"Authorization": provide for user production
Quy ước API (API Conventions)
Các dấu gạch chéo ở cuối URL sẽ bị bỏ qua:
/transmissionstương đương với/transmissions/.Các đường dẫn URL, tên tham số truy vấn URL, và tên trường JSON đều phân biệt chữ hoa và chữ thường.
Các đường dẫn URL được viết bằng chữ thường, với dấu gạch ngang để phân tách các từ.
Các tham số truy vấn và trường JSON sử dụng kiểu camelCase.
Trạng thái HTTP cho biết một thao tác thành công hay thất bại, kèm theo thông tin chi tiết trong phần thân phản hồi HTTP.
Tất cả API trả về mã lỗi chuẩn của HTTP.
Các tham số truy vấn không mong muốn và các trường trong phần thân yêu cầu sẽ bị bỏ qua.
Dữ liệu kiểu số trong JSON được giới hạn ở kiểu số nguyên 32-bit có dấu.
Lỗi (Errors)
Khi thực hiện một yêu cầu API, bạn có thể nhận được thông báo lỗi phản hồi. Thông báo lỗi này có thể chỉ ra vấn đề từ yêu cầu của bạn hoặc sự cố xảy ra từ phía chúng tôi. Các lỗi đi kèm với mã lỗi và dữ liệu JSON cung cấp thông tin chi tiết hơn như: thông điệp cụ thể, mô tả, và mã API.