사용자 지정 API를 만들 때 솔루션을 사용해야 합니다. 솔루션에 익숙하지 않은 경우 먼저 솔루션 만들기를 읽습니다.
솔루션은 게시자에 연결되어야 합니다. 게시자에는 연결된 특정 사용자 지정 접두사가 있습니다. 사용자 지정 API를 만들 때 사용자 지정 접두사를 사용해야 하며 이 접두사는 솔루션 게시자가 사용하는 것과 동일해야 합니다. 다음 지침에서는 sample 값을 게시자에게 설정된 사용자 지정 접두사로 사용합니다.
중요합니다
- 이제 사용자 지정 API를 만들기 위한 더 나은 환경이 제공됩니다. 플러그 인 등록 도구 내에서 디자이너를 사용할 수 있습니다. 추가 정보: 플러그 인 등록 도구를 사용하여 사용자 지정 API 만들기
- 사용자 지정 API를 만든 후에는 사용자 지정 API를 만드는 데 관련된 많은 필드를 변경할 수 없습니다. 시작하기 전에 사용자 지정 API의 디자인을 신중하게 계획해야 합니다. 나중에 사용자 지정 API를 만든 후 변경해야 하는 경우 기존 레코드를 삭제하고 사용자 지정 API를 다시 만들어야 할 수 있습니다. 여기에서 변경할 수 없는 열에 대한 정보를 검토합니다. CustomAPI 테이블
사용자 지정 API 레코드 만들기
솔루션의 드롭다운에서 New>More>Other>사용자 지정 API 를 선택합니다.
필드를 편집하여 사용자 지정 API의 속성을 설정합니다. 다음 필드에 대한 값을 설정해야 합니다. 자세한 내용은 사용자 지정 API 테이블 열을 참조하세요.
플러그 인을 만들기 전에 플러그 인 형식 에 대한 값을 설정할 수 없습니다. 나중에 변경할 수 있습니다.
저장을 선택합니다. 양식은 다음과 같이 표시됩니다
요청 매개 변수를 생성하십시오
사용자 지정 API에는 매개 변수가 필요하지 않습니다. 논리에 필요한 데이터를 전달하는 데 필요한 만큼의 매개 변수를 만듭니다.
솔루션의 드롭다운에서 새>기타>>사용자 지정 API 요청 매개 변수를 선택합니다.
필드를 편집하여 사용자 지정 API 요청 매개 변수의 속성을 설정합니다. 자세한 내용은 CustomAPIRequestParameter 테이블 열을 참조하세요.
저장을 선택합니다. 양식은 다음과 같이 표시됩니다.
응답 속성 만들기
작업을 나타내는 사용자 지정 API에는 응답 속성이 필요하지 않습니다. 함수에는 하나 이상이 있어야 합니다. 작업이 성공하면 성공 응답을 반환합니다. 실패하면 오류를 반환합니다. API에서 반환하는 모든 데이터에 대한 응답 속성을 정의해야 합니다.
단일 Entity 또는 EntityCollection 응답 속성만 정의된 경우 응답은 해당 형식입니다. 여러 속성 또는 단순 형식의 하나 이상의 속성이 있는 경우 API는 각 응답 속성이 해당 복합 형식의 속성인 복합 형식을 반환합니다.
예를 들어 사용자 지정 API 고유 이름이 sample_CustomAPIExample면 정의한 각 응답 속성에 대한 속성으로 명명된 sample_CustomAPIExampleResponse 복합 형식을 반환합니다.
솔루션의 드롭다운에서 새>기타>기타>사용자 지정 API 응답 속성을 선택합니다.
필드를 편집하여 사용자 지정 API 응답 속성의 속성을 설정합니다. 자세한 내용은 CustomAPIResponseProperty 테이블 열을 참조하세요.
저장을 선택합니다. 양식은 다음과 같이 표시됩니다.
서비스 문서에서 결과를 확인하십시오.
사용자 지정 API에 대한 속성을 설정 IsPrivate 하지 않은 경우 이제 브라우저에서도 요청을 사용하여 GET 서비스 정의를 검색할 수 있습니다. 사용자 환경의 URL인 https://yourorg.crm.dynamics.com경우 브라우저 주소 필드에 이 URL을 입력하여 $metadata https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata검색할 수 있습니다.
결과를 검색하여 사용자 지정 API의 이름을 찾습니다. 예를 들어 위의 단계를 사용하여 정의된 API는 다음과 같습니다.
<ComplexType Name="sample_CustomAPIExampleResponse">
<Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
<Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
<ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>
사용자 지정 API 테스트
사용자 지정 API를 만든 후 사용해 볼 수 있습니다. 기본 작업을 정의하도록 플러그 인 형식을 설정하지 않은 경우에도 지금 테스트하여 올바르게 호출할 수 있는지 확인할 수 있습니다. 응답 속성은 null과 같은 기본값을 반환합니다. 추가 정보: 사용자 지정 API 호출
사용자 지정 API 플러그 인 유형 업데이트
사용자 지정 API에 대한 플러그 인을 작성하는 방법에 대한 자세한 내용은 사용자 지정 API에 대한 플러그 인 쓰기를 참조하세요.
어셈블리를 등록한 후에는 만든 사용자 지정 API에 대한 플러그 인 형식 값을 설정해야 합니다. 조회 속성이므로 어셈블리를 등록할 때 만든 형식을 나타내는 플러그 인 형식만 찾아야 합니다.
플러그 인 유형을 설정하면 사용자 지정 API를 테스트하여 올바른 결과가 반환되는지 확인할 수 있습니다.
사용자 지정 API를 만드는 다른 방법
플러그 인 등록 도구는 사용자 지정 API 디자이너를 제공합니다. 추가 정보: 플러그 인 등록 도구를 사용하여 사용자 지정 API 만들기
디자이너 외부에서 사용자 지정 API를 만들 수 있는 클라이언트 애플리케이션을 만들기 위한 요구 사항이 있을 수 있습니다. 사용자 지정 API에 대한 데이터는 테이블에 저장되므로 코드를 사용하여 만들 수 있습니다. 추가 정보: 코드를 사용하여 사용자 지정 API를 만듭니다.
솔루션 파일을 편집하여 사용자 지정 API를 만들어 ALM 프로세스를 더 효율적으로 처리할 수 있습니다. 추가 정보: 솔루션 파일을 사용하여 사용자 지정 API를 만듭니다.
참고하십시오
사용자 지정 API 만들기 및 사용
플러그 인 등록 도구를 사용하여 사용자 지정 API 만들기
코드를 사용하여 사용자 지정 API 만들기
솔루션 파일을 사용하여 사용자 지정 API 만들기
사용자 고유의 메시지 만들기