플레이어를 Lingara 계정에 연결

매개변수

Lingara-Versionheaderstring선택

이 요청에 응답할 API 버전입니다. 지정하지 않으면 액세스 토큰은 해당 클라이언트에 고정된 버전을, 토큰이 없는 요청은 현재 버전을 받습니다. 개발 중인 버전은 여기에서 지정해야만 사용할 수 있습니다. 알 수 없는 버전에는 코드 api_version_unknown과 함께 400으로 응답합니다. GET /v1/versions에서 버전 목록을 확인할 수 있습니다.

player_refpathstring필수

플레이어의 토큰을 발급할 때 사용한 player_ref를 퍼센트 인코딩한 값입니다. guild/42는 guild%2F42가 됩니다.

응답

200 플레이어의 연결

statusLinkStatus필수

subjectstring필수

계정의 lgr_sub_: 이 플레이어의 이벤트가 이제부터 가지는 값입니다.

previous_subjectstring필수

게스트의 lgr_sub_: 플레이어의 이전 이벤트가 유지하는 값입니다. 둘 다 같은 player_ref로 보내세요.

linked_atstring필수

연결이 만들어진 시각. existing 응답에서는 첫 호출의 시각입니다.

scopesarray of string필수

이 플레이어의 토큰이 이제 가질 수 있는 최대 범위: 플레이어 토큰이 가질 수 있는 범위 중 계정이 허용한 것.

carriedobject필수

이 호출이 계정으로 옮긴 행 수(테이블별). 개수가 있는 테이블만 표시됩니다.

keptobject필수

이 호출이 게스트에게 남긴 행 수(테이블별): 아직 작성 중인 플랜이나 계정에 이미 있던 행. 여기의 lesson_plans에 완료된 플랜이 생기면 다시 호출하세요.

오류

402application/json

사용량 기반 과금 클라이언트의 호출이 아무것도 소모하기 전에 거부되었습니다. spend_cap_reached: 클라이언트 또는 그 계정이 월 지출 한도에 도달했습니다. 연동 페이지에서 한도를 올리세요. metered_billing_inactive: 이 계정에서 사용량 기반 과금이 활성화되어 있지 않습니다. 연동 페이지에서 설정하거나 결제 수단을 업데이트하세요.

410application/json

이 요청에 응답하는 API 버전은 지원이 종료되었습니다. Lingara-Version에 지원되는 버전을 보내거나 클라이언트를 다른 버전에 다시 고정하세요.

4XXapplication/json

요청이 거부되었습니다. code는 이유를, error는 이를 문장으로 알려 줍니다.

503application/json · text/plain

서비스를 일시적으로 사용할 수 없습니다. Retry-After에 있는 초만큼 기다린 후 다시 시도하세요. 점검 중에는 본문이 오류 엔벨로프가 아닌 일반 텍스트입니다.

5XXapplication/json

요청이 거부되었습니다. code는 이유를, error는 이를 문장으로 알려 줍니다.

codestring필수

요청이 거부된 이유를 분기에 쓸 수 있는 안정적인 코드로 나타냅니다. 예: insufficient_scope(403), rate_limited(429), 사용량 기반 과금 클라이언트의 경우 spend_cap_reached(402)와 metered_billing_inactive(402).

errorstring필수

예시

curl -X PUT "https://api.getlingara.com/v1/embed/players/$PLAYER_REF/link" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

라이브러리가 더 편하신가요? 라이브러리 섹션을 보세요.