Integration

All examples assume that the editor instance was configured as follows:

new SynapEditor('synapEditor', {
	'editor.upload.image.api': "/uploadImage",
	'editor.upload.video.api': "/uploadVideo",
	'editor.upload.file.api': "/uploadFile",
	'editor.import.api': "/importDoc"
});

Uploading an image file

[request]

이미지 업로드를 위해 지정한 고객 시스템의 URL로 에디터에서 해당 파일을 전송합니다. 이 URL은 앞서 설정된 editor.upload.image.api 값에 해당합니다.

Send image file to your system via the URL that was configured as 'editor.upload.image.api' property.

Request URL: http://hostname/uploadImage
Request Method: POST

[response]

이미지가 정상적으로 업로드되면, 고객 시스템에서는 아래와 같은 응답을 돌려주어야 합니다.

Once after the image has been successfully uploaded, your system should respond with the following data:

{
    "uploadPath":"uploads/36a43f36f442b5824c6b061eb734553d.png"
}

Uploading a video clip

[request]

동영상 업로드를 위해 지정한 고객 시스템의 URL로 에디터에서 해당 파일을 전송합니다. 이 URL은 앞서 설정된 editor.upload.video.api 값에 해당합니다.

Send video file to your system via the URL that was configured as 'editor.upload.video.api' property.

Request URL: http://hostname/uploadVideo
Request Method: POST

[response]

동영상이 정상적으로 업로드되면, 고객 시스템에서는 아래와 같은 응답을 돌려주어야 합니다.

Once after the video has been successfully uploaded, your system should respond with the following data:

{
    "uploadPath":"uploads/36a43f36f442b5824c6b061eb734553d.mp4"
}

Uploading an arbitrary file

[request]

임의의 파일 업로드를 위해 지정한 고객 시스템의 URL로 에디터에서 해당 파일을 전송합니다. 이 URL은 앞서 설정된 editor.upload.file.api 값에 해당합니다.

Send some arbitrary file to your system via the URL that was configured as 'editor.upload.file.api' property.

Request URL: http://hostname/uploadFile
Request Method: POST

[response]

동영상이 정상적으로 업로드되면, 고객 시스템에서는 아래와 같은 응답을 돌려주어야 합니다.

Once after the file has been successfully uploaded, your system should respond with the following data:

{
    "uploadPath":"uploads/36a43f36f442b5824c6b061eb734553d.docx"
}

문서 임포트

임포트를 위한 문서변환은 Synap Editor가 제공하는 sedocConverter 모듈에 의해 서버에서 이루어진다(sedocConverter는 Linux, Windows 환경을 지원한다).
사용자가 에디터에서 임포트를 실행하면 문서는 서버로 전송되고 sedocConverter 모듈로 변환 후 변환결과가 에디터로 전송된다.

When you import a document, the format conversion is done at the server side by 'sedocConverter' module.
'sedocConverter' module runs on either Linux or Windows platform, and requires appropriate license to activate.

에디터에서 임포트가 실행되면 'editor.import.api'에 지정된 API(예; "/importDoc")로 문서가 전송된다.
이 때 Back-end API 부분은 아래 개발환경 별 Example을 참고하여 직접 구현해야 한다.

After choosing the document to be imported, the Editor sends it to the location designated with 'editor.import.api' key upon configuration (e.g. /importDoc).
The service code for that location (e.g. /importDoc) which is wrapping around 'sedocConverter' , needs to be prepared at the customer side, since the service environment differs from site to site.
Please refer to the link below for a sample implementation.

• Java Spring Framework Example
• Java Servlet Example
• ASP.NET (C#) Example
• ASP(Classic) Example
• PHP Example
• PHP4 Example

에디터 환경설정에서 임포트를 "editor.import.api": "/importDoc" 와 같이 설정한 경우 아래와 같이 요청과 응답이 이루어진다.

[request]

클라이언트에서 문서 임포트를 위해 지정한 URL에 file(문서)를 전송한다.

Send document file to be imported via the URL that was configured as 'editor.import.api' property.

Request URL: http://hostname/importDoc
Request Method: POST

[response]

문서 파일이 정상적으로 변환되면 아래와 같은 응답을 클라이언트로 전송해줘야 한다.

Once after the file has been successfully converted, your system should respond with the following data:

{
    "serializedData":[10, 213, 156, ...],
    "importPath": "works/36a43f36f442b5824c6b061eb734553d"
}

관련정보