Verify API(Application Programming Interface)

Verify 애플리케이션 프로그래밍 인터페이스(API)에 접근하여 사내 애플리케이션 개발에 활용할 수 있습니다.

IBM® Verify 문서 허브지원 자세한 내용은 의 API 문서를 참조하십시오.

IBM 교육 IBM 교육 에서 API 관련 동영상을 Verify 시청하세요.

HTTP 메소드

각 API 리소스는 이름 지정된 URI(Uniform Resource Identifier)로 식별되며 다음 표준 HTTP 메소드를 사용하여 액세스됩니다. HTTP 메소드는 오브젝트에서 의도된 조치를 표시합니다.
표 1. HTTP 방법
HTTP 메소드 설명
GET 지정된 URL에서 리소스 또는 관계를 검색합니다.
  • URL 리소스 수준에서 요청을 수행하면 (<resource-noun>) 검색 및 페이징 제약 조건(검색 섹션 참조)에 따라 모든 인스턴스가 반환됩니다.
  • 리소스 ID 수준에서 요청을 수행하면<resource-noun>/<resource-id> 개별 리소스가 반환됩니다.
  • 관계 이름 수준에서 요청을 수행하면 (<relationship>) 검색 및 페이징 제약 조건에 따라 모든 관계 인스턴스가 반환됩니다.
  • 기본 응답 상태 코드는 200입니다.
  • 최대값이 1000인 "count"와 같은 조회 매개변수를 추가하여 결과에 대한 페이지 매김을 사용자 정의할 수 있습니다.
  • 관계 ID 수준에서 요청을 수행하면<relationship>/<relationship-id> 개별 관계 인스턴스가 반환됩니다.
POST 지정된 URL에서 리소스 또는 관계를 작성합니다.
  • URL 리소스 수준에서 요청을 보내면<resource-noun> 해당 리소스가 생성됩니다.
  • 관계 ID 수준에서 요청을 수행하면 (<relationship>) 새로운 관계가 생성됩니다.
  • 벌크 로드 작성에 사용할 수 있습니다.
PUT 지정된 URL에서 리소스 또는 관계를 업데이트합니다.
  • URL 리소스에 대한 요청(<resource-noun>)은 해당 리소스를 업데이트합니다.
  • 관계 ID 수준에서 요청을 수행하면 (<relationship>) 새로운 관계가 업데이트됩니다. 일부 관계를 수정할 수 없으므로 일부 경우 잘못된 요청으로 고려될 수 있습니다.
  • 읽기 전용 정보(예: 리소스 또는 관계 ID)를 변경하기 위한 요청은 잘못된 요청으로 고려됩니다.
PATCH

리소스의 부분적 업데이트에 사용됩니다.

  • URL 리소스 유형 수준에서 수행되는<resource-noun> 요청은 지정된 리소스에 대해 요청에 포함된 속성의 변경 사항만 업데이트합니다.
  • PATCH의 컨텐츠 유형은 application/json-patch+json입니다.
  • 삭제 오퍼레이션이 기본 ID(기본 키에 맵핑되는 고유 ID 또는 특성)로 지정되는 경우 전체 오브젝트가 삭제됩니다.
DELETE 지정된 URL에서 리소스 또는 관계를 제거합니다.
참고: 대량 삭제를 하려면 PATCH를 사용하십시오.