API 사용 방법

아키스케치 API 요청 형식 및 엔드포인트를 안내하고 있어요.

API 연동 중 문의사항이나 개선 제안이 있으신가요?

아키스케치 API 연동에 대한 질문이나, 건의사항이 있다면 연동/개발 문의에 문의 주세요. 아키스케치 담당자와 질의를 주고 받을 수 있어요.

API 헤더

아키스케치 OPEN-API 요청은 HTTPS 환경에서 JSON 형식으로 호출해주세요.

Content-Type: application/json

인증에는 API-KEY 인증을 사용해요. X-API-KEY 인증에 필요한 인증 토큰을 발급받은 다음 API를 사용해주세요.

X-API-KEY: {OPEN-API-KEY}

아키스케치 엔드포인트 URL

별도의 테스트 환경 없이 운영 환경 엔드포인트로 통합 제공되어 더욱 빠른 연동이 가능해요.

• 운영 환경: https://openapi.archisketch.com

API 요청 한도

기업 당 각 API별로 요청횟수를 쓰기 초당 30회, 읽기 초당 50회 이하로 제한하고 있어요. 그 이상으로 요청을 보낼 시 일부 요청에 대해서 response에 TOO_MANY_REQUEST ErrorType을 내려주며 거절될 수 있어요.

API 업데이트 정책

연동을 시작하기 전에 아래 아키스케치 API 정책을 확인해주세요.

• API 응답 필드와 에러 코드는 예고 없이 추가, 변경될 수 있어요. 업데이트로 인한 오류가 발생하지 않도록 주의하세요.

• API를 제거할 때는, API가 제거된다고 미리 알려드리니 꼭 확인하세요.

• 자세한 API 업데이트 내용은 공지사항을 확인해주세요.