29일마다 API 키를 갱신하는 스킬 설계 따라하기 가이드

API 키의 갱신 정책과 기준 시각을 정하고, 발급부터 검증·교체·기록까지 이어지는 흐름을 설계합니다. 실패 알림과 재시도 조건도 정해 갱신 작업이 멈췄을 때 확인할 수 있게 합니다.

전체 흐름

사전 준비

• 키를 발급하는 서비스에 접근할 수 있는 계정과 필요한 권한을 준비합니다.
• 서비스의 키 발급·만료·폐기 정책과 검증 방법을 확인합니다.
• 자동화가 사용하는 키의 저장 위치와 접근 권한을 확인합니다.
• 마지막 갱신 완료 시각을 기록할 방법과 실패 알림을 받을 경로를 정합니다.

단계별로 따라 하기

1. 키 종류와 서비스 정책을 확인합니다

사용 중인 서비스가 키의 자동 갱신이나 새 키 발급을 지원하는지 확인합니다. 만료일과 실제 교체 절차는 다를 수 있으므로, 만료 시점과 새 키 발급 방법, 기존 키 폐기 조건을 각각 확인합니다.

• 새 키 발급이 수동 작업만 지원되면 자동화의 역할을 갱신 시점 알림까지로 정합니다.
• 발급 API가 제공되더라도 서비스 정책에서 허용하는 작업 범위를 확인합니다.

2. 29일 주기의 기준을 정합니다

최초 발급일이나 마지막 갱신 완료 시각 중 하나를 기준으로 정합니다. 가능하면 실제 만료일과 서비스의 만료 계산 방식을 확인하고, 29일 간격이 적절한지 판단합니다.

• 마지막 갱신 완료 시각을 기록하고 다음 실행 조건의 기준으로 삼습니다.
• 실행이 늦거나 누락됐을 때 다시 처리할 조건을 정합니다.
• 성공하지 않은 작업은 갱신 완료로 기록하지 않습니다.

3. 새 키를 발급하고 유효성을 확인합니다

서비스에서 허용하는 절차로 새 키를 발급합니다. 사용처의 값을 바꾸기 전에 키가 유효하고 필요한 권한을 갖췄는지 서비스에서 제공하는 검증 방법으로 확인합니다.

• 검증 요청과 결과를 확인할 방법을 정합니다.
• 키 값 자체는 실행 기록이나 알림에 남기지 않습니다.

4. 자동화의 사용처를 교체합니다

검증을 통과한 키로 자동화에서 참조하는 값을 바꿉니다. 키를 코드나 시나리오에 직접 적지 말고, 사용 중인 플랫폼의 비밀값 저장 기능이나 접근 제어 방식을 활용합니다.

기존 키를 폐기하는 시점은 서비스 정책에 따릅니다. 새 키와 기존 키를 함께 쓸 수 있는지 확인하고, 교체 실패 시 기존 키를 사용할 수 있는지와 되돌리는 방법도 정합니다.

5. 결과를 기록하고 실패 경로를 시험합니다

발급 실패와 검증 실패, 사용처 교체 실패를 구분해 기록합니다. 성공한 경우에만 마지막 갱신 완료 시각을 갱신하고, 실패 시 확인할 알림과 재시도 조건을 시험합니다.

• 재시도는 서비스의 응답과 요청 제한 정책을 고려해 정합니다.
• 실행이 누락됐을 때 예정일이 지났는지 확인하고 처리할 조건을 점검합니다.

체크리스트

운영 메모

• 서비스 정책이나 키 발급 방식이 바뀌면 주기와 발급·교체 절차를 다시 확인합니다.
• 실행이 늦거나 누락되면 마지막 성공 시각을 기준으로 미처리 작업이 있는지 확인합니다.
• 발급은 성공했지만 교체가 실패했다면 새 키가 적용된 범위와 기존 키의 작동 여부를 확인합니다.
• 요청 제한이나 재시도 불가 오류가 발생하면 반복 요청을 멈추고 원인을 확인한 뒤 대응합니다.