본문으로 건너뛰기

GitpleLive API

GitpleLive의 API 문서입니다.

API 사용 전 host, header 등 기본 형태를 확인해주세요.

Host​

  • xxx.gitplelive.io
KeyValue
Content-Typeapplication/json
APP_ID발급받은 APP ID
APP_API_KEY발급받은 APP API KEY
위험

주의!
절대 클라이언트 APP에서 API_KEY를 사용한 API 호출을 하지 마십시오.
API_KEY가 노출되면 무분별하게 악용 될 수 있습니다.

URL Encoding​

http 요청 시 파라미터는 url 인코딩을 권고합니다.

  • 예시

    const userId = encodeURIComponent(user_id);

    const url = 'https://{API_HOST}/v1/users/' + user_id;
    const url = 'https://{API_HOST}/v1/users/?base_user_id=' + user_id;

Response​

응답 데이터 중 생성, 갱신 시에 필수가 아니거나 기본값이 없는 필드는 값이 등록되지 않으면 누락될 수 있습니다.
사용 시 유효성 검사를 권고합니다.

Timezone​

시간 형식 데이터는 UTC+0 기준입니다.

  • UTC±00:00