> For the complete documentation index, see [llms.txt](https://codevasp.gitbook.io/code-api-docs-ko/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codevasp.gitbook.io/code-api-docs-ko/code-cipher/api-specification.md).

# API Specification

실행한 Cipher서버에 swagger가 세팅되어있습니다. 아래의 URL로 확인하실 수 있습니다.

```
https://<<your server host>>:<<port>>/swagger-ui/index.html 
```

CODE API를 사용하기에 앞서 자동으로 CODE API 요청 형식에 맞춰 암호화된 파라미터 및 바디를 만들어주는 모듈입니다. Encrypt/Decrypt 기능 외에 CODE API와 1:1 로 매핑되어 있습니다.

Cipher 모듈에 파라미터 입력 요청 시, 해당 response를 받으신 후 실제 CODE API를 호출 하시면 됩니다.&#x20;

Cipher는 독립된 서버로 구성하시고 내부망에 설치 하셔서 외부와 연결을 하지 않아도 되기 때문에 네트워크 상에는 암호화된 데이터만 옮겨가 개인정보 보호를 보장할 수 있게 됩니다.&#x20;

모든 요청에 allianceType 파라미터를 body에 입력하실 수 있습니다 allianceType은 CODE 트래블룰과 연동되어있는 다른 트래블룰 프로토콜을 이용하여 처리해야하는 경우 사용하는 변수입니다. 현재 `CODE`, `verifyVASP` 의 트래블룰 프로토콜로 연동이 가능하며, 추후, 더 많은 프로토콜이 연결되면 추가될 예정입니다.

기본값은 CODE 이며, 입력하지 않으셔도 처리 됩니다.&#x20;

* allianceType (enum)
  * CODE
  * VERIFYVASP


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://codevasp.gitbook.io/code-api-docs-ko/code-cipher/api-specification.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.