API Template 등록 및 관리

Prev Next

Classic/VPC 환경에서 이용 가능합니다 .

Workflow를 구성하기 위한 API를 등록하고 관리하는 메뉴입니다. 새로운 API를 등록하거나 수정할 수 있으며 등록된 API의 호출 테스트를 수행하고 사용하지 않는 API는 삭제할 수 있습니다. API를 등록하는 단계에서 테스트할 수 있으므로 API 호출 시 예상되는 응답 결과를 바로 확인할 수 있습니다

API 등록

API의 이름, Method, URL, 요청 파라미터를 등록하여 새로운 API를 등록할 수 있습니다. 네이버 클라우드 플랫폼에서 제공하는 API를 등록하는 경우에는 Authority를 NCP Signature로 선택하면 별도의 Signature 설정 과정 없이 네이버 클라우드 플랫폼의 API를 사용할 수 있습니다.

API Template을 등록하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Management & Governance > API Workflow 메뉴를 차례대로 클릭해 주십시오.

  2. API Template 메뉴에서 [API Template 등록] 버튼을 클릭해 주십시오.

  3. 등록할 API 정보를 입력해 주십시오.

    항목 설명
    이름 등록할 API 이름 입력
    URL 등록할 API의 URL 입력
    URL에 https//url/{value} 형태로 입력 시 Parameters의 Key 값에 {value}가 자동 입력됨
    API URL 입력 후 [Test] 버튼을 클릭하여 API 테스트 가능
    Tag API 검색 시 사용할 키워드 입력. 입력한 태그별로 API 분류 가능
    Authority - 선택없음: 네이버 클라우드 플랫폼 또는 AWS에서 제공하지 않는 HTTP 기반 API인 경우 선택
    - NCP Signature: 네이버 클라우드 플랫폼에서 제공하는 API인 경우 선택
    - AWS Signature: AWS에서 제공하는 API인 경우 선택
    Request 호출할 API의 Parameters 값, Headers 값, Body 값 입력

  4. Request에 Parameters, Headers, Body 값을 입력하고 [추가] 버튼을 클릭해 주십시오.
    apiworflow-apitemplate_add_ko.png

    항목 설명
    Parameters Key: Parameters Key 값 입력
    설명: Parameters에 대한 설명 입력
    Type: Parameters 유형 선택(기본값: Query, URL에서 Path 사용 시 자동으로 Path 유형이 추가됨)
    Default Value: 기본값 입력
    Required: 필수 여부 선택
    Headers Key: Headers 값 입력
    설명: Headers 값에 대한 설명 입력
    Body Body 값 입력

  5. API를 테스트하려면 URL 필드의 [Test] 버튼을 클릭해 주십시오.

  6. Test Request 창이 나타나면 [Test] 버튼을 클릭한 후 결과를 확인하고 [닫기] 버튼을 클릭해 주십시오.

  7. [저장] 버튼을 클릭해 주십시오.

  8. API 목록을 확인해 주십시오.

등록된 API 목록 확인

등록된 API를 확인할 수 있습니다. Method에 따른 필터 기능을 제공하며, 이름, URL, Tag를 기준으로 검색할 수 있습니다. 등록된 API를 클릭하여 해당 API에 대한 상세 정보를 확인할 수 있습니다.
등록된 API를 확인하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Management & Governance > API Workflow 메뉴를 차례대로 클릭해 주십시오.
  2. API Template 메뉴에서 등록된 API를 확인해 주십시오.
    • 화면 우측 상단에서 URL, 이름, Tag를 기준으로 검색할 수 있습니다.
    • 등록된 API의 Method를 기준으로 검색할 수 있습니다.

API 수정

등록한 API의 정보를 수정하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Management & Governance > API Workflow 메뉴를 차례대로 클릭해 주십시오.
  2. API Template 메뉴를 클릭하여 등록된 API 목록을 확인해 주십시오.
  3. 수정할 API를 선택하고 [수정] 버튼을 클릭해 주십시오.
  4. 수정 화면이 나타나면 정보를 수정하고 [Test] 버튼을 클릭해 주십시오.
  5. [저장] 버튼을 클릭해 주십시오.

API 삭제

더 이상 사용하지 않는 API는 삭제할 수 있습니다. 등록된 API를 삭제하는 방법은 다음과 같습니다.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > Management & Governance > API Workflow 메뉴를 차례대로 클릭해 주십시오.
  2. API Template 메뉴를 클릭하여 등록된 API 목록을 확인해 주십시오.
  3. 삭제할 API를 선택하고 [삭제] 버튼을 클릭해 주십시오.
  4. 삭제 창이 나타나면 [삭제] 버튼을 클릭해 주십시오.