다른 시스템에서 Tulip과 연동하려면 Tulip API를 설정하고 사용하십시오.
This article assumes previous experience with APIs.
Tulip은 커넥터를 통해 다른 여러 시스템의 API와 연동됩니다. 커넥터를 사용하면 Tulip 앱에서 HTTP 또는 SQL 쿼리를 실행할 수 있습니다.
다른 경우에는 외부 시스템이 Tulip 내에만 존재하는 데이터를 조회할 수 있도록 허용하고 싶을 수도 있습니다. Tulip API를 사용하면 외부 시스템에서 Tulip과 통신할 수 있습니다. 이 문서에서는 Tulip API의 설정 및 테스트 과정을 단계별로 안내합니다.
Tulip API는 이러한 외부 시스템을 Tulip과 다양한 방식으로 통합하는 데 유용합니다. 현재 이 API는 Tulip 테이블에서만 작동합니다. 여기에는 테이블 레코드를 새로운 정보로 업데이트하거나, 테이블을 생성하거나, 테이블 내 레코드 수를 조회하는 작업이 포함될 수 있습니다.
Stations API 기능
Stations API를 사용하면 새로운 스테이션을 신속하게 관리하고 온보딩할 수 있습니다. 일반적인 기능으로는 스테이션, 스테이션 그룹 및 인터페이스(이전의 디스플레이 장치)를 생성, 열거 및 수정하는 것이 있습니다. 자세한 내용은 여기에서 확인하세요.
예를 들어, 새로운 사용자를 온보딩할 때마다 새 인터페이스를 설정할 수 있는 링크를 자동으로 전송하는 스크립트를 작성할 수 있습니다.
실습 가이드
Prior to r383, Service Accounts were called "API Tokens".
Stations API 설정
서비스 계정 설정 방법은 이 문서를 참조하십시오.
If you have a Service Account already set up, you may use that API Key and Secret
- 계정 설정에서 ‘Tulip API ’ 탭을 선택하세요.
- '서비스 계정 생성'을 클릭합니다.
- 서비스 계정 이름을 지정합니다.
- '범위(Scopes)'에서
'stations: read'및'stations: write'를선택하십시오:
Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.
- '저장'을 클릭합니다.
Stations API 사용
Stations API를 설정한 후에는 스테이션을 생성할 수 있습니다. 이 예제에서는 Postman을 사용하여 생성 작업을 수행합니다.
- Post 요청에 API 엔드포인트를 추가합니다.
- '헤더(Headers)'에서 'Auth 헤더'를 추가합니다.
- 본문(Body)에서 JSON 객체를 포함하도록 요청을 구성합니다. 이 요청의 일반적인 형식은 다음과 같습니다:
요청을 구성할 때 워크스페이스를 포함하십시오. 예:<your-instance-name>.tulip.co/api/stations/v1/w/1/stations 이 예시는 stations 엔드포인트를 호출합니다. 워크스페이스가 없는 경우 1로 설정해야 합니다.
- '보내기'를 클릭하여 요청을 실행하면, 성공을 나타내는 200 응답을 받게 됩니다.
확인하려면 'Shop Floor' 탭의 'Stations' 페이지로 이동하여 스테이션이 생성되었는지 확인하십시오.
