요청 매개변수 탭을 사용하여 경로, 쿼리 등 다양한 매개변수를 요청에 추가할 수 있습니다. 이렇게 추가된 매개변수가 엔드포인트 URL에 사용된 매개변수와 일치하는지 확인하십시오.

작업

다음과 같은 요청 매개변수 작업이 활성화됩니다.

추가
요청에 매개변수를 추가하려면
추가 아이콘을 클릭하여 매개변수를 추가합니다. 매개변수 테이블 제목에 표시된 매개변수 개수는 자동으로 업데이트됩니다.
편집
요청에서 사용 가능한 기존 매개변수를 편집하려면
매개변수 테이블에서 적절한 매개변수의 세로 생략 부호 아이콘 위에 마우스를 올리고, 편집 아이콘을 클릭하여 매개변수 유형, 키, 값, 또는 값 유형을 편집합니다.
활성화/비활성화
요청에서 사용 가능한 매개변수를 활성화 또는 비활성화하려면 다음과 같은 경우 매개변수를 비활성화할 수 있습니다.
  • API 요청이 기본값을 사용할 때.
  • 제어된 커넥터 패키지 롤아웃에서 새로운 기능을 소개할 때.
  • 커넥터 패키지에서 새로운 기능을 테스트하고 반복할 때.
  • 오류가 있는 매개변수가 포함된 커넥터 패키지의 문제를 해결할 때.
매개변수 테이블에서 활성화하거나 비활성화하려는 매개변수의 세로 생략 부호 아이콘 위에 마우스를 올린 후 활성화/비활성화 토글을 클릭합니다. 매개변수의 상태가 매개변수 테이블에서 적절하게 업데이트됩니다. 비활성화된 매개변수는 게시된 커넥터 패키지에 포함되지 않습니다.
복사
요청에서 사용 가능한 기존 매개변수를 복제하려면
매개변수 테이블에서 적절한 매개변수의 세로 생략 부호 아이콘 위에 마우스를 올리고, 복사 아이콘을 클릭하여 선택한 매개변수를 복제합니다. 복사 모달에 새 키를 입력했는지 확인하세요. 원래 매개변수의 다른 모든 속성이 새 매개변수로 복사됩니다. 복사된 후 새 매개변수는 기본적으로 활성화됩니다. 필요한 경우, 활성화/비활성화 토글을 사용하여 매개변수를 수동으로 비활성화합니다. 복사 옵션을 사용하여 새 매개변수를 생성하면 매개변수 테이블 제목의 매개변수 개수가 자동으로 업데이트됩니다.
복사 모달에서 중복된 매개변수의 매개변수 유형, 값, 또는 값 유형을 변경할 수 있습니다.
삭제
요청에서 사용 가능한 매개변수를 삭제하려면
매개변수를 삭제하려면 다음 중 하나를 수행합니다.
  • 테이블 헤더에서 모두 선택 확인란을 클릭한 다음, 테이블 위에 있는 삭제 아이콘을 클릭하여 여러 매개변수를 삭제합니다.
  • 각 매개변수의 세로 줄임표 메뉴 위에 마우스를 올린 후 삭제 아이콘을 클릭하여 매개변수를 개별적으로 삭제합니다.

매개변수 테이블

매개변수 테이블 제목에는 해당 작업에서 사용된 요청 매개변수의 총 개수가 표시됩니다. 여기에는 활성화된 매개변수와 비활성화된 매개변수가 모두 포함됩니다.

테이블에서 다음 매개변수 세부 정보를 확인할 수 있습니다.

열 설명
유형 매개변수의 유형을 표시합니다. 매개변수는 쿼리 매개변수이거나 경로 매개변수일 수 있습니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 매개변수 유형을 볼 수 없습니다.
키 매개변수 키를 표시합니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 키를 볼 수 없습니다. 키는 헤더의 일부로 전송됩니다.
값 매개변수 값을 표시합니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 이 값을 확인하고 업데이트할 수 있습니다.
값은 사용자가 제공합니다. 값의 상태를 표시합니다.
  • 예: 사용자가 값을 제공한 경우. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 매개변수를 구성할 때 적절한 값을 제공해야 합니다.
  • 아니요: 값이 하드 코딩된 경우. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 이 값을 볼 수 없습니다. 이 값은 헤더의 일부로 전송됩니다.
상태 매개변수의 상태를 표시합니다.
  • 활성화됨: 매개변수가 활성화된 경우.
  • 비활성화됨: 매개변수가 비활성화된 경우.
라벨 사용자가 제공한 값에 대한 매개변수 레이블을 표시합니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 매개변수 라벨을 볼 수 있습니다.
설명 매개변수 설명을 표시합니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 매개변수 설명을 볼 수 있습니다.

요청 매개변수 추가

요청 매개변수를 추가하려면 다음 단계를 수행합니다.

  1. 구성 창에서 요청 매개변수 탭을 클릭합니다.
  2. 테이블 상단의 매개변수 추가 버튼 또는 더하기 아이콘(+)을 클릭하여 매개변수를 추가합니다.
  3. 매개변수 추가 모달에서 다음 작업을 수행하세요.
    1. 매개변수 유형: 다음 중 하나를 선택합니다.
      • 쿼리: 이러한 매개변수는 URL 경로에서 ? 뒤에 추가됩니다. 예: /accounts?user_account=company.
      • 경로: 이러한 매개변수는 URL 경로에 바로 추가됩니다. 예: /accounts/{user_account}.
    2. 키: 적절한 키 이름을 입력합니다. 키 이름은 Bot editor 또는 API Task 편집기에서 패키지 사용자에게 표시되지 않습니다. 이 이름은 헤더의 일부로 전송됩니다.

      요청 매개변수 키에 . 및 @와 같은 특수 문자를 포함할 수 있습니다.

    3. 값 설정 섹션에서 다음 옵션 중 하나를 선택합니다.
      유형 설명
      하드 코딩 매개변수에 대해 하드 코딩된 값을 입력합니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 이 값을 볼 수 없습니다. 이 값은 헤더의 일부로 전송됩니다.
      사용자 제공
      1. 값 입력 유형: 값 입력 유형을 보호하려면 이 확인란을 활성화합니다. 확인란을 활성화하면 자격증명, 변수 또는 안전하지 않은 문자열을 통해 매개변수를 입력할 수 있습니다.
      2. 이 필드는 필수입니까? 매개변수의 요구 사항에 따라 아니요 또는 예를 선택합니다.
      3. 값(선택사항): 값을 입력합니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 이 값을 확인하고 업데이트할 수 있습니다.
      4. 라벨: 매개변수에 대한 레이블을 입력합니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 매개변수 라벨을 볼 수 있습니다.
      5. 설명(선택 사항): 매개변수에 대한 설명을 입력합니다. 패키지 사용자는 Bot editor 또는 API Task 편집기에서 매개변수 설명을 볼 수 있습니다. 설명은 편집기에서 도움말 텍스트로 표시됩니다.
  4. 추가를 클릭하여 요청에 매개변수를 추가합니다.

    새 매개변수가 매개변수 테이블에 표시되며, 테이블 제목의 매개변수 개수가 자동으로 업데이트됩니다.

매개변수를 더 추가하려면 단계를 반복합니다.