HTTP 연결하기

SAPP에 HTTP API를 리소스로 등록하면 앱에서 외부 API를 호출할 때 공통 주소와 헤더 설정을 사용할 수 있습니다. 연결하기 전에 사용할 API의 기본 주소와 필요한 인증 정보를 준비하세요.

리소스 추가하기

프로젝트의 리소스 메뉴에서 리소스 추가를 선택합니다.

Name

앱에서 리소스를 구분할 이름을 입력합니다.

http.base

여러 API를 연결한다면 용도에 따라 이름을 구분할 수 있습니다.

http.orders
http.crm
http.internal

Type

리소스 유형에서 http를 선택합니다.

예시 입력하기

HTTP 리소스는 Config JSON에 연결 정보를 입력합니다. 먼저 오른쪽의 예시 입력을 선택하세요. 그러면 dev와 prod 영역에 HTTP 리소스에 맞는 기본 형식이 입력됩니다.

{
  "baseURL": "https://api.example.com",
  "headers": {}
}

필요한 값으로 수정한 뒤 저장합니다.

Config JSON 설정하기

baseURL

baseURL에는 API 요청에 공통으로 사용할 기본 주소를 입력합니다.

{
  "baseURL": "https://api.example.com",
  "headers": {}
}

예를 들어 앱에서 /orders 경로를 호출하면 다음과 같은 주소로 요청할 수 있습니다.

https://api.example.com/orders

baseURL에는 일반적으로 API의 공통 주소까지만 입력하고, 개별 요청 경로는 앱에서 지정합니다.

headers

headers에는 API를 호출할 때 공통으로 전달할 HTTP 헤더를 입력합니다. 별도의 헤더가 필요하지 않다면 빈 객체로 둡니다.

{
  "baseURL": "https://api.example.com",
  "headers": {}
}

인증 토큰이 필요한 경우에는 API에서 안내하는 헤더 형식에 맞춰 입력합니다.

{
  "baseURL": "https://api.example.com",
  "headers": {
    "Authorization": "Bearer YOUR_TOKEN"
  }
}

여러 헤더가 필요한 경우에는 다음과 같이 함께 입력할 수 있습니다.

{
  "baseURL": "https://api.example.com",
  "headers": {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  }
}

헤더 이름과 값은 연결하려는 API의 공식 문서를 확인해 입력하세요.

dev와 prod 설정하기

SAPP에서는 개발 환경과 운영 환경의 HTTP 설정을 각각 입력할 수 있습니다.

dev: 개발 및 테스트에 사용할 API
prod: 실제 운영 앱에서 사용할 API

개발용과 운영용 API 주소가 다르다면 각각 다른 baseURL과 헤더를 입력합니다.

{
  "baseURL": "https://dev-api.example.com",
  "headers": {}
}

{
  "baseURL": "https://api.example.com",
  "headers": {}
}

같은 API를 사용한다면 dev와 prod에 동일한 설정을 입력할 수 있습니다.

저장하기

dev와 prod의 Config JSON을 확인한 뒤 저장을 선택합니다. 인증 토큰이나 API 키가 포함된 헤더는 앱 코드나 공개 문서에 직접 작성하지 말고 SAPP 리소스 설정에서 관리하세요.

튜토리얼

세부 가이드

리소스 추가하기

Name

Type

예시 입력하기

Config JSON 설정하기

baseURL

headers

dev와 prod 설정하기

저장하기

​리소스 추가하기

​Name

​Type

​예시 입력하기

​Config JSON 설정하기

​baseURL

​headers

​dev와 prod 설정하기

​저장하기

리소스 추가하기

Name

Type

예시 입력하기

Config JSON 설정하기

baseURL

headers

dev와 prod 설정하기

저장하기