Getting Started

Tutorial

Flow에서 제공하는 API를 사용하기 위해서 다음과 같은 과정을 따라야 합니다.
1. 테스트하고자 하는 API를 선택합니다.
2. Request 탭에서 필요한 데이터를 확인합니다.
3. 각 API별 Test 탭에서 테스트를 진행합니다.
4. 테스트 탭에서 출력된 응답을 Response 탭의 예시 데이터와 비교해서 확인합니다.
5. API를 사용자의 실제 프로젝트에 적용합니다.
* 조회를 제외한 API 호출은 분당 최대 60회로 제한되어 있습니다. (조회는 분당 최대 100회 제한)

제공 API

사용자 인증

키관리 페이지에서 발급받은 API Key를 이용해 API 요청을 인증할 수 있습니다.
API Key 값은 모든 API 요청 시, 필수로 포함되어야 합니다.
이에 대한 자세한 설명은 각 Request, Codesnippet 탭에 설명되어 있습니다.

API

API는 응용 프로그램 간에 통신하기 위한 규약 또는 인터페이스를 의미합니다.
소프트웨어 개발자들이 서로 다른 시스템 또는 애플리케이션 간에 데이터를 교환하고 상호작용하기 위해 사용됩니다.
API는 일련의 기능, 프로토콜, 도구, 클래스 등으로 구성됩니다.
다른 개발자들이 해당 API를사용하여 애플리케이션 또는 서비스의 기능을 확장하거나 특정 기능을 이용할 수 있게 해줍니다.

HTTP

HTTP는 웹 서버와 클라이언트 간에 데이터를 전송하는 프로토콜입니다.
웹 브라우저가 서버로부터 웹 페이지를 요청하고, 서버는 요청된 데이터를 응답으로 전송합니다.
HTTP는 주로 HTML 문서, 이미지, 동영상, 파일 등을 전송하는 데 사용됩니다.
HTTP는 요청 메서드(GET, POST, PUT, DELETE 등), 상태 코드(200, 404, 500 등), 헤더, 본문(body) 등으로 구성됩니다.
개발자들은 HTTP를 사용하여 서로 다른 애플리케이션 간에 데이터를 주고받을 수 있습니다.

JSON

JSON은 데이터 교환을 위한 경량의 데이터 형식입니다.
텍스트 형식으로 구성되며, 사람과 기계 모두 이해하기 쉽습니다.
JSON은 속성-값 쌍으로 이루어진 데이터 객체를 표현하는 데 사용됩니다.
주로 웹 애플리케이션에서 데이터를 전송하고 저장하는 데에 널리 사용되며, API에서도 데이터를 교환하기 위한 표준 형식으로 많이 사용됩니다.
JSON은 다양한 프로그래밍 언어에서 지원되고, 구조적이며 유연한 데이터 형식으로 인기가 있습니다.
JSON 값에 줄바꿈을 입력하고 싶으면 하단에 이스케이프 문자(escape character) 설명을 참고하시길 바랍니다.

//JSON Example

{

  "name": "John Doe",

  "age": 30,

  "email": "johndoe@example.com"

}

Escape Character

단어나 문자열 안에서 특별한 의미를 갖는 문자를 표현하기 위해 사용되는 것이 "이스케이프 문자(escape character)"입니다.
이스케이프 문자는 백슬래시(\)와 함께 특정 문자 조합으로 구성됩니다.
주로 문자열 리터럴 안에서 사용되며, 특정 문자를 일반 문자로 해석하도록 도와줍니다.
주요한 이스케이프 문자들은 다음과 같습니다:

Types