VRain Open API logo

Giới thiệu

VRain Open API là bộ thư viện mở cho các đối tác đang sử dụng hệ thống đo mưa VRain, giúp đối tác thực hiện việc lấy dữ liệu mưa từ các trạm đo của mình, nhằm phục vụ công tác phân tích, dự báo hoặc cho các mục đích hoặc tính năng khác hiện chưa được hỗ trợ bởi hệ thống VRain

VRain Open API hỗ trợ chuẩn REST, URL sắp xếp theo resource và sử dụng HTTP response code để báo lỗi. Toàn bộ Open API hỗ trợ các HTTP Verb thông dụng (POST, PUT, GET, DELETE) và response sẽ được trả về theo JSON format.

Hiện tại VRain Open API chưa hỗ trợ CORS, do đó, việc tích hợp với VRain hiện nay chỉ có thể được thực hiện ở server side.

Việc sử dụng Open API đòi hỏi đối tác phải chấp nhận các điều khoản sử dụng. Click vào đây để xem các điều khoản sử dụng.

Chứng thực

Toàn bộ Open API đều phải được chứng thực bởi API Key, được cung cấp cho từng đối tác. Vui lòng giữ API Key cẩn thận và không chia sẻ cho bất kì ai.

Để chứng thực, thêm header x-api-key với giá trị là API Key được cung cấp vào trong request.

Toàn bộ API request phải được thực hiện qua HTTPS. Hệ thống sẽ từ chối toàn bộ API request gởi qua HTTP, hoặc không có API Key.

Lỗi

Mã Tên Mô tả
200 OK Thành công
400 Bad Request Request sai hoặc thiếu tham số
403 Forbidden Chứng thực thất bại

Cấu trúc body khi VRain trả về ở dạng JSON như sau

{
  "code": "mã lỗi",
  "message": "thông tin thêm"
}

/v1/stations/stats

Lấy dữ liệu đo mưa

Trả về số liệu lượng mưa của tất cả các trạm, xếp theo thứ tự thời gian giảm dần từ thời điểm hiện tại (hoặc end_time)

Tham số
start_time
Thời điểm bắt đầu, theo format yyyy-MM-dd HH:mm:ss
end_time
Thời điểm kết thúc, theo format yyyy-MM-dd HH:mm:ss. Mặc định: thời gian hiện tại
last_x_records
Số lượng dữ liệu gần nhất trả về cho mỗi trạm đo. Mặc định:10
  • start_time và last_x_records là 2 tham số không xuất hiện cùng lúc trong 1 request.
  • Khoảng cách start_time và end_time không được vượt quá 1 tuần.
curl "https://openapi.vrain.vn/v1/stations/stats?last_x_records=10"
  -H "x-api-key: 123456"
  -H 'Content-Type: application/json; charset=utf-8'

curl "https://openapi.vrain.vn/v1/stations/stats?start_time=2017-11-09%2000:00:00&end_time=2017-11-09%2002:00:00"
  -H "x-api-key: 123456"
  -H 'Content-Type: application/json; charset=utf-8'

{
  "Station A": [{
    "time_point": "16:00 09/11",
    "depth": 10.0
  }, {
    "time_point": "15:00 09/11",
    "depth": 12.0
  }, {
    "time_point": "14:00 09/11",
    "depth": 0
  }, {
    "time_point": "13:00 09/11",
    "depth": 0
  }, {
    "time_point": "12:00 09/11",
    "depth": 0
  }, {
    "time_point": "11:00 09/11",
    "depth": 0
  }, {
    "time_point": "10:00 09/11",
    "depth": 0
  }, {
    "time_point": "09:00 09/11",
    "depth": 0
  }, {
    "time_point": "08:00 09/11",
    "depth": 0
  }, {
    "time_point": "07:00 09/11",
    "depth": 0
  }],
  "Station B": [{
    "time_point": "16:00 09/11",
    "depth": 0
  }, {
    "time_point": "15:00 09/11",
    "depth": 0
  }, {
    "time_point": "14:00 09/11",
    "depth": 0
  }, {
    "time_point": "13:00 09/11",
    "depth": 0
  }, {
    "time_point": "12:00 09/11",
    "depth": 0
  }, {
    "time_point": "11:00 09/11",
    "depth": 0
  }, {
    "time_point": "10:00 09/11",
    "depth": 0
  }, {
    "time_point": "09:00 09/11",
    "depth": 0
  }, {
    "time_point": "08:00 09/11",
    "depth": 0
  }, {
    "time_point": "07:00 09/11",
    "depth": 0
  }]
}

Giới thiệu

Về Chính sách

Chính sách sử dụng Open API của VRain mô tả mối quan hệ giữa VRain với tất cả các đối tác đang sử dụng hệ thống đo mưa của VRain và muốn tương tác trực tiếp với hệ thống VRain qua Open API.Chính sách này dựa trên nguyên tắc tôn trọng lẫn nhau.

VRain tin rằng các đối tác hoạt động với sự minh bạch và nhất quán, vì vậy khi có nhầm lẫn, hay có nghi vấn về việc sử dụng dữ liệu trái phép, hay có phản ánh về bất kỳ lý do gì, chúng tôi sẽ giúp các đối tác xử lý nhanh nhất.

Các thuật ngữ

  • Đối tác là các tổ chức đang sử dụng hệ thống đo mưa của VRain

  • VRain bao gồm máy chủ VRain, trang web vrain.vn và tất cả các trạm đo mưa do VRain quản lý và bảo trì.

  • Ứng dụng là bất kỳ phần mềm, hoặc máy chủ nào kết nối tới Open API của VRain

  • Open API là bộ thư viện mở, đóng vai trò như 1 phương thức trao đổi dữ liệu giữa Ứng dụng đối tác và VRain.

  • API Key là 1 mã số chứng thực cho 1 đối tác duy nhất, dùng để chứng thực với Open API

Với việc sử dụng Open API của chúng tôi, bạn hiểu và đồng ý với Chính sách được mô tả trong tài liệu này. Vui lòng đọc kỹ tài liệu.

Phạm vi

Phạm vi

Mục đích API của chúng tôi giúp các Ứng dụng thu thập dữ liệu đo mưa nhằm mục đích mở rộng tính năng hệ thống VRain hiện chưa cung cấp. Chúng tôi không liên quan tới bất kỳ giao dịch nào giữa Ứng dụng của đối tác với Người dùng của họ.

Tiêu chí lựa chọn

Các đối tác muốn sử dụng Open API phải cung cấp cho chúng tôi một số thông tin cần thiết trước khi chúng tôi cấp API Key cho bạn. Những thông tin này giúp chúng tôi hiểu rõ nhu cầu của bạn trước khi cung cấp Open API, nhằm hỗ trợ cho bạn tốt nhất.

Truy cập

Thông tin truy cập

Để giám sát việc ứng dụng của bạn sử dụng API của chúng tôi, bạn luôn phải sử dụng API Key do chúng tôi cung cấp. Bạn có thể liên hệ với VRain để được cấp API Key. Lưu ý luôn giữ kín API Key cho ứng dụng của bạn. Bạn là người chịu trách nhiệm cho các hoạt động trên ứng dụng của bạn.

Cấp phép sử dụng Open API

Chúng tôi trao cho tổ chức của bạn một quyền hữu hạn, không thể chuyển nhượng, không được chuyển nhượng và không độc quyền để sử dụng dịch vụ Open API của chúng tôi. Quyền này chỉ được phục vụ cho mục đích cho phép bạn và Người dùng của bạn sử dụng và tận hưởng những lợi ích của việc thu thập dữ liệu từ VRain.

Sử dụng

Bạn không được sử dụng sai API của chúng tôi. Bạn không được can thiệp vào việc chuyển giao các dịch vụ API cho các Ứng dụng khác hay là cố truy cập dữ liệu không được ủy quyền. Bạn chỉ có thể sử dụng API theo các quy định và luật về dữ liệu. Nếu chúng tôi nghi ngờ bất kỳ việc sử dụng sai nào, chúng tôi sẽ tạm ngưng hoặc ngừng việc bạn truy cập API mà không báo trước. API của chúng tôi phải luôn được sử dụng theo pháp luật. Chúng tôi sẽ báo cáo các hành vi gian lận và bất hợp pháp tới các cơ quan thực thi pháp luật. Chúng tôi không có nghĩa vụ giám sát bất kỳ hoạt động hay nội dung nào – nhưng nếu có khiếu nại về việc sử dụng sai, chúng tôi có thể điều tra hoặc có hành động khác mà chúng tôi cho là phù hợp, bao gồm việc đưa ra cảnh báo, đình chỉ hoặc chấm dứt dịch vụ, từ chối truy cập.

Quyền sở hữu

Việc sử dụng API của chúng tôi không cho bạn quyền sở hữu của bất kỳ quyền sở hữu trí tuệ nào trong API của chúng tôi hay là nội dung bạn truy cập. Bạn không được sử dụng bất kỳ thương hiệu hay logo nào từ/của/trong API của chúng tôi trừ khi bạn sở hữu chúng hay được phép từ chủ sở hữu chúng. Bạn không được xóa bỏ hay thay đổi bất kỳ thông tin nào, bao gồm các thông báo pháp lý, hiển thị trong hoặc cùng với API của chúng tôi.

Cấp phép nhãn hiệu

Chúng tôi trao cho bạn một quyền hữu hạn, không độc quyền, không thể chuyển nhượng, không nhượng quyền được và không được chuyển nhượng, cho phép bạn hiển thị các đặc tính nhãn hiệu của chúng tôi để thúc đẩy hoặc quảng bá việc tích hợp các API trong Ứng dụng của bạn.

Bạn có thể quảng bá Ứng dụng của bạn, bao gồm thông báo tới các phương tiện truyền thông truyền thống và trực tuyến cũng như là Người dùng về Ứng dụng của bạn, miễn là bạn làm điều đó một cách chính xác và không có ngụ ý rằng Ứng dụng (Đối tác) của bạn được tạo ra hay được xác nhận bởi chúng tôi.

Trách nhiệm

Lời phủ nhận về đảm bảo

API của chúng tôi là đúng như hiện trạng. Chúng tôi không có các tuyên bố hay bảo đảm nào khác, rõ ràng hay ngụ ý, bao gồm nhưng không giới hạn: khả năng bán được, thích hợp cho một mục đích hay tiêu đề cụ thể, và không vi phạm; rằng API của chúng tôi sẽ đáp ứng các yêu cầu của bạn, sẽ luôn có sẵn, dễ tiếp cận, không bị gián đoạn, kịp thời, an toàn,hoặc hoạt động mà không có lỗi; rằng hệ thống phần mềm được xây dựng và thiết kế cho API và các Ứng dụng đối tác khác sẽ vận hành như cam kết; và/hoặc bất kỳ bảo đảm ngụ ý nào phát sinh từ quá trình giao dịch hoặc sử dụng thương mại; và bất kỳ nghĩa vụ, trách nhiệm, quyền, khiếu nại hoặc biện pháp khắc phục sai lầm cá nhân nào, có hoặc không phát sinh từ sự sơ suất của chúng tôi. Trong phạm vi hợp pháp đầy đủ cho phép chúng tôi từ chối bất kỳ và mọi sự đảm bảo.

Trách nhiệm hữu hạn

Chúng tôi sẽ không chịu trách nhiệm cho bất kỳ thiệt hại nào, bao gồm nhưng không giới hạn các thiệt hại trực tiếp, gián tiếp, ngẫu nhiên, trừng phạt và do hậu quả, phát sinh từ hoặc liên quan đến việc sử dụng API của chúng tôi hay bất kỳ thỏa thuận nào được ký kết liên quan đến việc sử dụng nói trên bao gồm nhưng không giới hạn việc không có khả năng sử dụng API của chúng tôi,hay bất kỳ cam kết hay hợp đồng của bên thứ ba nào nảy sinh từ việc mua được hay thu được bất kỳ dịch vụ hay hàng hóa nào hay là dữ liệu hoặc tin nhắn nhận được hay là giao dịch thông qua API của chúng tôi. Bạn sẽ bảo vệ, bồi thường và giải phóng chúng tôi khỏi bất kỳ mọi khiếu nại, chi phí, tổn thất, thiệt hại, phán quyết, hình phạt, lãi suất và chi phí (bao gồm cả phí luật sư hợp lý) dưới bất kỳ hình thức nào, được biết và chưa biết, nghi ngờ và không bị nghi ngờ, tiết lộ và không được tiết lộ phát sinh từ bất kỳ khiếu nại nào phát sinh từ hoặc liên quan đến:

a. bất kỳ vi phạm thực tế hay bị cáo buộc của các tuyên bố, bảo đảm hay nghĩa vụ của bạn trong Chính sách này; b. bất kỳ tranh chấp nào giữa Người dùng với ứng dụng của bạn bởi chúng tôi không tham gia hay liên quan đến giao dịch giữa bạn và người dùng

Với những mục đích trên, “Khiếu nại” có nghĩa là bất kỳ khiếu nại, hành động, kiểm toán, điều tra hay tố tụng khác lập bởi một người hoặc tổ chức. Việc giải phóng này mở rộng cho tất cả các khiếu nại được tuyên bố hoặc không tuyên bố, nghi ngờ hoặc không nghi ngờ, và coi là từ bỏ của mỗi và tất cả các quy định của Luật pháp Việt Nam hiện hành

Khác

Sửa đổi hoặc chấm dứt các dịch vụ của chúng tôi

Chúng tôi đang liên tục thay đổi và cải tiến API của mình. Chúng tôi có thể thêm vào hoặc bớt đi các chức năng hay đặc tính, và chúng tôi có thể tạm ngưng hoặc ngừng hẳn một dịch vụ API. Trong trường hợp chúng tôi tạm ngưng hoặc ngừng hẳn 1 dịch vụ API, chúng tôi sẽ phát thông báo trước để bạn chuẩn bị.

Các thay đổi đối với chính sách này

Chúng tôi có thể sửa đổi các điều khoản này hoặc bất kỳ điều khoản bổ sung để phản ánh các thay đổi về luật hoặc về các dịch vụ API của chúng tôi. Bạn nên rà soát các điều khoản này thường xuyên. Chúng tôi sẽ gửi thông báo về bất kỳ sửa đổi nào tới tài khoản của bạn. Các thay đổi sẽ không áp dụng hồi tố và sẽ có hiệu lực không sớm hơn mười bốn ngày sau khi được đăng tải. Tuy nhiên, những thay đổi đối với các chức năng mới của một dịch vụ API hay thay đổi vì lý do pháp lý sẽ có hiệu lực ngay lập tức. Nếu bạn không đồng ý với bất kỳ điều khoản sửa đổi nào đối với một dịch vụ API, bạn có thể ngưng sử dụng dịch vụ API đó. Bất kỳ điều khoản bổ sung sẽ kiểm soát xung đột với những điều khoản này, nếu có.
Các điều khoản này kiểm soát mối quan hệ giữa chúng ta khi bạn sử dụng API. Chúng không tạo ra bất kỳ quyền hưởng lợi của bên thứ ba nào. Chúng tôi sẽ thông báo tới bạn nếu có các điều khoản bổ sung khi chúng tôi thêm các dịch vụ hay yêu cầu liên quan đến API hay Sổ đăng ký. Chúng sẽ tự động trở thành một phần của Chính sách này và sẽ áp dụng cho bạn.

Giải quyết tranh chấp

Nếu bạn không tuân thủ Chính sách này, chúng tôi có thể hành động ngay lập tức, nhưng chúng tôi có quyền hành động vào bất cứ thời điểm nào sau này. Nếu một điều khoản cụ thể không thể thực thi, các điều khoản khác sẽ không bị ảnh hưởng. Bởi lẽ chúng tôi không phải là đại lý của bất kỳ Đối tác, Ứng dụng Đối tác hay Người dùng nào nên chúng tôi sẽ không đóng vai trò là đại lý của bất kỳ bên nào để giải quyết bất kỳ tranh chấp nào giữa Người dùng liên quan đến hoặc phát sinh từ bất kỳ giao dịch, hoạt động, quan hệ hay giao tiếp hoặc tương tự.

Những điểm cần lưu ý

Chính sách này, bao gồm bất kỳ điều khoản và điều kiện nào kết hợp trong tài liệu tham khảo, và các điều khoản và điều kiện chung của API, bao gồm nhưng không giới hạn các thông báo bảo mật và điều kiện sử dụng, là toàn bộ thỏa thuận của các bên liên quan đến chủ đề chính của Chính sách này, và thay thế và hủy bỏ tất cả các thỏa thuận, tuyên bố trước đây và hiện nay, cũng như hiểu biết của các bên liên quan đến vấn đề đề cập tại đây. Không có bất cứ điều gì được thể hiện, đề cập đến hay ngụ ý trong tài liệu này với mục đích hoặc được hiểu để cung cấp cho bất kỳ người nào khác ngoài các bên liên quan bất kỳ quyền, biện pháp hay yêu cầu pháp lý hoặc công bằng theo hoặc liên quan đến tài liệu này. Chính sách này và tất cả các tuyên bố, bảo đảm, thỏa ước, điều kiện và quy định đi kèm nhằm mục đích phục vụ lợi ích duy nhất và độc quyền của bạn và chúng tôi. Nếu bất kỳ điều khoản nào của Chính sách này bị coi là không hợp pháp, không có giá trị hoặc bất khả thi vì bất cứ lý do gì, thì điều khoản đó sẽ được xem là tách khỏi các điều khoản và điều kiện và sẽ không ảnh hưởng đến hiệu lực và tính thực thi của bất kỳ điều khoản còn lại nào. Việc từ bỏ bất kỳ quyền hay biện pháp nào được mô tả trong Chính sách này phải bằng văn bản và có chữ ký của các bên có thẩm quyền liên quan. Việc chúng tôi chậm trễ hay thiếu sót khi thực hiện các quyền hoặc biện pháp của chúng tôi sẽ không làm suy yếu hay bị coi là từ bỏ. Việc thực thi một quyền hay biện pháp một phần hay đơn lẻ sẽ không loại trừ việc tiếp tục thực hiện bất kỳ quyền hay biện pháp khác. Nếu chúng tôi không thể thực thi việc thực hiện chặt chẽ bất kỳ điều khoản nào của Chính sách này, điều đó sẽ không bị coi là từ bỏ quyền của bất kỳ bên nào đối với việc sau này thực thi điều khoản đó hay bất kỳ điều khoản nào khác của Chính sách này.

Liên hệ với chúng tôi

Nếu bạn có bất kỳ câu hỏi hay bình luận về những chính sách trên, vui lòng liên hệ chúng tôi qua email thetruongkt@gmail.com