클라비요 API 시작하기

예상 3 읽은 시간(분)

업데이트 2024년 8월 29일 오후 10:02 EST

API 호출에 대한 기본적인 이해와 클라비요 API를 통해 비즈니스에 어떤 이점을 얻을 수 있는지 알아보세요. 이 가이드에서는 클라비요의 API 테스트를 준비할 수 있도록 REST API, HTTP 메서드 및 개발자 도구에 대해 알아봅니다. 첫 번째 API 호출은 처음부터 끝까지 10분 안에 완료할 수 있습니다. 이미 API 호출에 익숙하고 API를 테스트할 준비가 되었다면 Postman 컬렉션 사용 방법에 대한 가이드를 참조하세요.

이 가이드 전반에 걸쳐 새로운 기술 용어가 소개될 경우 용어집으로 연결되는 링크를 제공합니다. 가이드의 어느 지점에서든 단어의 의미가 확실하지 않은 경우 기술 용어집을 확인하세요.

REST API란 무엇인가요?

REST API는 대표 상태 전송 및 애플리케이션 프로그래밍 인터페이스를 나타내는 약어 집합입니다. 이러한 용어는 소프트웨어가 다른 소프트웨어와 대화하고 서로 정보를 전달할 수 있도록 하는 구조화된 요청으로 더 간단하게 이해할 수 있습니다. API를 호출하면 정보가 저장된 서버에 요청을 제출하고, 서버는 요청된 데이터가 포함된 응답을 JSON 또는 JavaScript 객체 표기법 형식으로 반환합니다.

간단히 말해, REST API를 사용하면 클라비요에 저장된 데이터를 요청하고 해당 데이터를 사용자와 컴퓨터가 읽을 수 있는 형식으로 반환받을 수 있습니다.

표준 API 호출은 몇 초 만에 이루어집니다. 뒤에서는 여러분의 통화가 이루어집니다:

인터넷을 통해 구조화된 데이터 요청을 API로 전송합니다. 요청은 인터넷이 주로 사용하는 기본 네트워크 요청 유형인 HTTP를 통해 전송됩니다.
API는 요청을 수신하고 처리한 후 클라비요의 데이터베이스에서 요청된 정보를 가져옵니다.
그런 다음 API는 JSON 구조화된 형식을 사용하여 클라이언트 애플리케이션에 응답합니다.
클라이언트 애플리케이션에서 JSON 응답을 받게 됩니다.

이러한 지식은 데이터 전송이 어떻게 작동하는지 이해하는 데 도움이 되지만, API 호출을 시작하고 클라비요 API가 제공하는 가치를 활용하기 위해 반드시 필요한 것은 아닙니다. 첫 번째 API 호출을 시작하기 위해 알아야 할 모든 사항은 다음 섹션에서 다룹니다.

HTTP 메서드

HTTP 메서드는 요청이 전송되는 '동사'입니다. 이 가이드에서 다룰 HTTP 메서드는 두 가지입니다: GET과 POST입니다.

여기서는 사용하지 않겠지만 대부분의 REST API는 PUT, PATCH, DELETE와 같은 추가 HTTP 메서드를 지원한다는 점에 주목할 필요가 있습니다.

GET

GET 요청은 '읽기' 요청으로 가장 쉽게 이해할 수 있습니다. GET 요청은 API 엔드포인트에서 정보를 검색하여 JSON 형식의 응답으로 사용자에게 반환합니다. 이 요청은 데이터 읽기만 허용하므로 데이터를 수정하거나 덮어쓸 수 없으므로 가장 안전한 요청 유형입니다.

POST

POST 요청은 간단히 '쓰기' 요청으로 이해할 수 있습니다. POST를 사용하면 새 리소스를 만들거나 추가할 수 있습니다. 예를 들어 리스트 API에 대한 POST 요청은 계정에 새 리스트를 만드는 데 사용할 수 있고, GET 요청은 사용 가능한 모든 리스트를 검색하는 데 사용할 수 있습니다. 데이터를 게시할 때 클라비요가 요청을 완료할 수 있는 시기에 따라 응답이 달라질 수 있다는 점에 유의하세요.

필요한 도구

API는 워크플로에 많은 유연성을 제공하며 원하는 결과를 얻기 위해 특정 클라이언트 애플리케이션이나 언어 라이브러리를 사용할 필요가 없습니다. API 호출은 HTTP 요청을 사용하여 이루어지기 때문에 거의 모든 프로그래밍 언어에는 이러한 유형의 요청을 기본적으로 또는 널리 사용되는 언어 라이브러리를 통해 전송할 수 있는 기능이 있습니다. 또한 사용 중인 컴퓨터와 운영 체제에 따라 Apple의 터미널이나 Windows 명령줄과 같은 기본 애플리케이션을 사용하여 클라이언트 측 API를 호출할 수 있습니다. 하지만 이러한 애플리케이션을 사용하려면 명령줄 인터페이스에 대한 사전 지식이 필요합니다.

저희는 Postman이라는 무료 웹 및 데스크톱 애플리케이션을 사용합니다. Postman에는 유용한 사용자 인터페이스에 엔드포인트, 매개변수, 인증을 입력하면 API 요청을 쉽게 설정하고 전송할 수 있는 다양한 기능이 있습니다.

클라비요의 API 테스트

클라비요의 API는 다른 플랫폼이나 서버에서 클라비요 계정으로 데이터를 전송하거나 클라비요 계정 내에서 정보를 쿼리하는 데 유용합니다. 이제 API의 작동 방식을 이해했으니 비즈니스의 사용 사례에 맞게 API 테스트를 시작할 수 있습니다. 클라비요에서 사용 가능한 전체 API 목록은 API 참조 문서에서 확인하세요. Postman 컬렉션을 사용하여 첫 번째 클라비요 API 호출을 수행하는 방법에 대한 가이드를 따르세요.

추가 리소스

개발자 포털 리소스

클라비요의 개발자 포털에는 API를 최대한 활용할 수 있도록 도와주는 API 가이드와 참고 문서가 포함되어 있습니다. 아래 리소스를 확인하여 시작하세요:

클라비요 개발자 과정

클라비요 아카데미는 클라비요 API 구축을 시작하는 데 도움이 되는 개발자 과정을 제공합니다. 아래 강좌를 확인하세요:

이 도움말 문서가 유용했나요?

이 형식은 도움말 문서 피드백 용도로만 사용하세요. 지원 팀에 문의하는 방법.