The state of public APIs| Submit an API

|API RANK| by Escape.tech

Benchmark and ranking of 5138+ public APIs by Escape.tech

Back to the list Request ranking update

이노온 로라 디바이스 API 사용 메뉴얼. (ranked 2496 of 5138)

https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/kv0UL1oNRyYtRBuS3CyGv____api____json.json

GENERAL INFORMATION

본 문서에서는 이노온에서 제공하는 로라 디바이스와 연동되는 서버 API의 사용법에 대해 설명합니다.

API를 위해서 필요한 시스템 계정은 이노온에 문의하여 가입 요청을 해주셔야 합니다.
가입 요청을 해주시면 계정 생성, 어플리케이션 생성을 해드리고 생성된 계정에 제공된 디바이스를 할당해 드립니다.

API 개요

API는 RESTful 형태로 제공됩니다.
보안을 위해서 https 프로토콜만 지원하며, 사용자 인증을 위해서 JWT를 이용합니다.
API 호출에 대한 결과는 HTTP Response Code와 JSON 형태의 데이터입니다.
API의 사용법과 데이터 형식은 문서 하단의 데모 문서를 확인하시면 됩니다.

API 사용을 위한 계정 인증

제공되는 API는 인증을 위해서 JSON Web Token(JWT)을 이용합니다.
JWT 토큰은 /lora/api-token-auth/ 를 통해서 얻을수 있습니다.
JWT 토큰을 요청하기 위해서는 사용자 정보가 필요합니다.
사용자 정보는 이노온에 별도로 요청을 해주셔야 합니다.

획득한 JWT 토큰은 HTTPS Request 요청시 헤더에 첨부하여야 인증을 통과할 수 있습니다.
헤더는 Authorization: jwt JWTTOKEN 형태로 헤더를 추가합니다.

Swagger 사용을 위한 인증 등록

현재 보고 있는 Swagger 문서는 사용 방법을 제공함과 동시에 바로 테스트 해볼 수 있는 환경을 제공합니다.
하지만 앞서 말씀드린 것처럼 JWT를 이용하여 사용자 인증을 하기 때문에, Swagger에 사용자의 JWT를 등록해주어야 합니다.

  1. 우선 /lora/api-token-auth/ API를 이용하여 토큰을 얻습니다.
  2. 다음 우측 상단 "authorize" 버튼을 누릅니다.
  3. 그리고 value 입력창에 jwt <<user JWT token>> 형태로 입력을 합니다.
  4. 다음 Authorize 버튼을 누르면 자동으로 HTTPS Request 헤더에 jwt 토큰 정보가 담겨집니다.

...

SECURITY 4/5

The security score of an API is computed as the number of OWASP top 10 vulnerabilities detected in the API.

  • OWASP issues detected: API7:2023

PERFORMANCE 3/5

The performance score is derived from the median response time of the API, sometimes referred as p50. The median is the value separating the higher half from the lower half of a data sample, here the response times of the API.

  • The median response time of the API is 283 ms .

Get p50 under 220 ms to get a 4/5 score.

RELIABILITY 5/5

The reliability score is derived from the number of inconsistent server responses, either server errors or non-conforming return values.

  • Self compliance: response objects matched the declared response types.
  • Server errors: the server did not return any 5xx error.

DESIGN 2/5

The design score reflects the quality of the specification file (usually named openapi.json or swagger.json). Having a high-quality specification file (with up-to-date types and examples) help developers understand the API and tools produce relevant documentation.

  • Respects OpenAPI 2.0 schema specification.
  • Contains comments and summaries.
  • Contains examples.
  • Does not contain duplicated objects.

Popularity 0/5

The popularity score is computed from the number of references to the API found on the internet. Have your API used by many developers to get a higher score!

Last scanned: 5/4/2023