Tulip API 테스트하기

API 키 설정 방법은 ‘테이블’, ‘운영자’, ‘기계’ 관련 문서를 참조하십시오.

Tulip 커넥터를 사용하여 Tulip API 테스트하기

커넥터 구성 방법을 숙지하고, 설정해 둔 API 서비스 계정을 사용하여 커넥터를 설정하세요(서비스 계정 구성 방법은 이 문서를 참조하세요).

커넥터 설정이 완료되면 ‘함수 생성’을 클릭하세요. 이 예시에서는 테이블에서 레코드를 가져오는 방법을 단계별로 안내해 드리겠습니다.

먼저 GET, POST, PUT, HEAD, PATCH 또는 DELETE를 사용하여 요청을 구성한 다음, 요청을 보낼 특정 URL을 지정해야 합니다(API 기능에 대한 자세한 내용은 여기에서 확인하세요) .

https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/tables/(TableID)/records

(서비스 계정 자체에서) 인증 정보, 요청 헤더(필요한 경우), 쿼리 매개변수(URL 자체 또는 쿼리 매개변수 형식 - 자세한 내용은 쿼리 매개변수 설정 방법 참조)를 반드시 추가해야 합니다.

또한, 커넥터 함수가 앱이나 자동화 프로세스로 다시 전달해야 할 입력 또는 출력을 지정할 수 있습니다.

Postman을 사용하여 Tulip API 테스트하기

다음에서는 오퍼레이터를 생성하는 방법을 살펴보겠습니다. 이 예제에서는 Postman을 사용하여 생성 작업을 수행합니다.

먼저, Post 요청에 API 엔드포인트를 추가합니다.

그런 다음, ‘Authorization’에서 ‘Basic Auth’를 선택하고, ‘Username’에 API 키를, ‘Password’에 API 시크릿을 입력합니다.

'헤더(Headers)' 섹션에서 'Auth' 헤더를 추가합니다.

본문(Body)에서 JSON 객체를 포함하도록 요청을 구성합니다. 이 요청의 일반적인 형식은 다음과 같습니다.

{"role": "operator","name": "string","badge_id": "string"}

그러면 다음과 같은 형태가 됩니다:

'보내기'를 클릭하여 요청을 실행하면, 성공을 나타내는 201 응답을 받게 됩니다. 확인을 위해 '설정'에서 사용자 목록을 확인하여 사용자가 성공적으로 생성되었는지 확인할 수 있습니다.

요청이 실패한 경우, 키(Key)와 시크릿(Secret)이 올바른지 반드시 확인하세요. 특정 응답 코드에 대한 자세한 내용은 Tulip API 페이지의 API 문서 섹션을 참조하세요.

API 문서를 사용하여 Tulip API 테스트하기

워크스페이스 또는 계정 설정에서 Tulip API로 이동하세요. 그곳에서 '서비스 계정 생성' 옵션 옆에 있는 '자세히 알아보기'를 클릭하세요.

그러면 생성된 키를 사용하여 API를 테스트할 수 있는 페이지로 이동합니다. 이 페이지에는 문서도 제공되며, 다양한 용도에 맞는 요청 본문 예시도 확인할 수 있습니다.

이 페이지에는 외부 시스템에서 API 요청을 구성하는 데 필요한 서버 URL도 포함되어 있습니다. API에 익숙해지려면 ‘승인(Authorize)’ 버튼을 클릭하세요.

이 버튼을 클릭하면 테스트를 위한 API 구성에 대한 추가 정보를 확인할 수 있습니다. 입력란에 다음 내용을 입력하세요:

• 사용자 이름: API 키
• 비밀번호: 시크릿

'승인'을 클릭하면 테이블에 대한 일반적인 HTTP 요청을 테스트해 볼 수 있습니다.

이 페이지의 각 옵션은 확장하여 테스트할 수 있습니다. 각 요청은 해당 응답에 대한 유용한 정보를 제공합니다.

이 페이지에는 Tulip의 일부 구성 요소에 대한 스키마 정보도 포함되어 있습니다. 예를 들어, 테이블 레코드를 생성할 때는 각 열에 적합한 JSON 형식을 아는 것이 유용합니다. 아래는 열에 대한 스키마 예시입니다: