initial Cloud Agent APIs¶
initial Platform DID Agent API Documents
DID Agent 안내¶
- 기관사용자는 아래의 DID API를 사용하여 Legacy 시스템(ERP, HR시스템 등)과 연동 및 증명서를 손쉽게 발생할 수 있습니다.
- initial DID Platform의 DID Agent는 Event Driven(이벤트 구동형) 방식이기 때문에 기관 사용자는 Webhook 서버를 준비하고 url 등록해아 합니다.
Open API Page¶
initial console 가입 Master 회원은, 아래 사이트에서 Test 가능합니다.
REST API Method¶
- 기본 URI :
- {domain}/Resorce/Method
- e.g.
https://dev-console.myinitial.io/agent/api/connections/create-invitation
- e.g.
- 개발망
- API Version V1 : https://dev-console.myinitial.io/agent/api
- API Version V2 : https://dev-console.myinitial.io/agent/v2/api
- 운영망
- API Version V1 : https://console.myinitial.io/agent/api
- API Version V2 : https://console.myinitial.io/agent/v2/api
- {domain}/Resorce/Method
- 요청형식 (Header)
- ** Content-Type : application/json **
- ** Accept: application/json **
- ** Authorization: {{Bearer token}} **
- e.g.
curl -X POST "https://dev-console.myinitial.io/agent/api/connections/create-invitation" -H "accept: application/json" -H "Authorization: Bearer 2ca4dd8a-1234-1234-1234-c5fb0286f2cc" -H "Content-Type: application/json" -d "{}"
- 응답형식 (Header)
- Content-Type : application/json; charset=utf-8
API List¶
- Mandatory(필수) APIs¶
| Category | Method | Resource | Description | Swagger |
|---|---|---|---|---|
| Connection | POST |
** /connections/create-invitation ** | 신규 초대장(invitation) 생성 | TEST |
| Issue | POST |
** /issue-credential/records/{cred_ex_id}/send-offer ** | 발행자(issuer)가 사용자(holder)에게 VC 발행 | TEST |
| Issue | POST |
/revocation/revoke | 발행자(issuer)가 사용자(holder)에게 발행한 VC 폐기 | TEST |
| Issue(enc) | POST |
** /enc/issue-credential/records/{cred_ex_id}/send-offer ** | (암호화)발행자(issuer)가 사용자(holder)에게 VC 발행 | TEST |
| Verify | POST |
** /present-proof/send-verification-request ** | 검증자(verifier)가 사용자(holder)에게 VC 검증 요청하기 | TEST |
| Message | POST |
** /connections/{conn_id}/send-message ** | 연결된 사용자에게 Message(개인정보 이용 동의서등) 보내기 | TEST |
- Optional APIs¶
| Category | Method | Resource | Description | Swagger |
|---|---|---|---|---|
| Connection | GET |
/connections | 모든 연결(connections) list 확인 | TEST |
| Connection | GET |
/connections/{conn_id} | 특정 connection ID 정보 확인 | TEST |
| Issue | GET |
/issue-credential/records | credential 발급관련 모든 기록 확인 | |
| Verify | GET |
/present-proof/records | 모든 Verify(present-proof) 기록 확인 | |
| DID | GET |
/resolver/resolve/{did} | W3C DID Doc 가져오기 | |
| Issue | POST |
/issue-credential/records/{cred_ex_id}/problem-report | 발급 과정 취소 | |
| Verify | POST |
/present-proof/records/{pres_ex_id}/problem-report | 검증/제출 과정 취소 |