API 서명 처리

API 서명은 요청의 진위성과 무결성을 검증하는 보안 메커니즘입니다. 이 가이드에서는 Apidog에서 서명 생성을 자동화하여 각 요청마다 서명을 수동으로 가져올 필요가 없도록 하는 방법을 설명합니다.

서명 자동화 전략

각 요청 전에 서명 엔드포인트에 수동으로 접근하는 대신, Apidog의 스크립팅 기능을 사용하여 다음을 수행하십시오.

서명 로직을 구현하는 공개 스크립트를 생성합니다.

요청 매개변수를 사용하여 서명을 자동으로 생성합니다.

스크립트 또는 환경 변수를 통해 요청에 서명을 첨부합니다.

API 전처리기에서 공개 스크립트를 참조합니다.

구현 방식

방법 1: 직접 스크립트 수정

환경 변수를 사용하지 않고 스크립트를 통해 서명 매개변수를 추가하고 요청 정보를 직접 수정합니다.

장점:

환경 변수 관리가 필요 없습니다.

매개변수가 즉시 업데이트됩니다.

구성이 더 간단합니다.

방법 2: 환경 변수

서명을 생성하여 환경 변수에 작성한 다음, API 매개변수에서 해당 변수를 참조합니다.

장점:

여러 요청에서 재사용할 수 있습니다.

디버깅 및 모니터링이 더 쉽습니다.

서명을 중앙에서 관리할 수 있습니다.

방법 3: 외부 프로그램

다른 언어로 구현된 서명의 경우 dog.execute 메서드를 사용하여 외부 프로그램을 호출하십시오.

예시: MD5 기반 서명

서명 생성 규칙

1단계: 매개변수 문자열 작성

비어 있지 않은 모든 매개변수를 집합 M에 수집합니다.

매개변수를 ASCII 코드 기준 오름차순(사전순)으로 정렬합니다.

URL 키-값 형식으로 매개변수를 연결합니다: key1=value1&key2=value2...

결과: stringA

중요 규칙:

매개변수 이름을 ASCII 코드 기준 오름차순으로 정렬하십시오.

빈 매개변수 값은 서명에서 제외됩니다.

매개변수 이름은 대소문자를 구분합니다.

sign 매개변수 자체는 서명에서 제외됩니다.

2단계: 서명 생성

stringA 끝에 키를 연결하여 stringSignTemp를 얻습니다.

stringSignTemp에 MD5 알고리즘을 적용합니다.

결과를 대문자로 변환하여 signValue를 얻습니다.

공개 스크립트 구현

예시: 번역 API 서명

서명 생성 규칙

1단계: 문자열 연결

다음 값을 순서대로 연결합니다.

appid: 애플리케이션 ID

q: 번역할 텍스트(UTF-8 인코딩)

salt: 난수

key: 플랫폼에서 할당한 키(관리 콘솔에서 확인 가능)

결과: appid + q + salt + key

2단계: 서명 생성

연결된 문자열에 MD5 알고리즘을 적용하여 32비트 소문자 서명을 얻습니다.

중요 참고 사항:

번역할 텍스트(q)는 UTF-8로 인코딩되어야 합니다.

appid+q+salt+key를 연결할 때 q에 URL 인코딩을 적용하지 마십시오.

서명이 생성된 후 HTTP 요청을 보내기 전에 q에 URL 인코딩을 적용하십시오.

예시 요청

공개 스크립트 구현

모범 사례

사례	설명
환경 변수 사용	민감한 키는 스크립트가 아니라 환경 변수에 저장하십시오.
매개변수 검증	서명을 생성하기 전에 필수 매개변수를 확인하십시오.
디버깅을 위한 로그 기록	`console.log()`를 사용하여 서명 생성 문제를 디버깅하십시오.
엣지 케이스 처리	빈 값, 특수 문자, 인코딩을 고려하십시오.
로직 중앙화	서명 로직의 중복을 방지하기 위해 공개 스크립트를 사용하십시오.
철저한 테스트	알려진 테스트 케이스로 서명 생성을 검증하십시오.

서명 자동화 전략#

구현 방식#

방법 1: 직접 스크립트 수정#

방법 2: 환경 변수#

방법 3: 외부 프로그램#

예시: MD5 기반 서명#

서명 생성 규칙#

공개 스크립트 구현#

예시: 번역 API 서명#

서명 생성 규칙#

예시 요청#

공개 스크립트 구현#

모범 사례#

서명 자동화 전략

구현 방식

방법 1: 직접 스크립트 수정

방법 2: 환경 변수

방법 3: 외부 프로그램

예시: MD5 기반 서명

서명 생성 규칙

공개 스크립트 구현

예시: 번역 API 서명

서명 생성 규칙

예시 요청

공개 스크립트 구현

모범 사례