Document 接口描述

 

操作PowerPoint文档，包括创建PowerPoint文档，获取文档信息，设置幻灯片尺寸，将PowerPoint转换为其他文档格式以及拆分PowerPoint文档。

接口方法1：getPptDocument()获取PowerPoint文档信息

HTTP请求方法：GET

请求URL：https://api.e-iceblue.cn/v1/powerpoint/{name}/Document

请求参数：

参数 是否必选 类型 可选值范围 说明
name 是 string   原文档名称
password 否 string   原文档密码，没有则为null
folder 否 string   存放原文档的文件夹，没有则为null
storage 否 string   文档存储空间，使用冰蓝云配置的2G空间存贮文档，可设置为null

Java代码示例：

import spire.cloud.powerpoint.sdk.*;
import spire.cloud.powerpoint.sdk.model.*;
import spire.cloud.powerpoint.sdk.api.DocumentApi;
import spire.cloud.pdf.sdk.ApiException;

public class getPptDocument {
    static String appId = "your id";
    static String appKey = "your key";
    static String baseUrl = "https://api.e-iceblue.cn";
    static Configuration configuration = new Configuration(appId, appKey, baseUrl);
    static DocumentApi documentApi = new DocumentApi(configuration);

    public static void main(String[] args) throws ApiException {

        String name = "getPptDocument.pptx";
        String password = null;
        String storage = null;
        String folder = "input";
        Document response = documentApi.getPptDocument(name, password, storage, folder);
    }
}

接口方法2：createPptDocument()创建PowerPoint文档

HTTP 请求方法：POST

请求URL：https://api.e-iceblue.cn/v1/powerpoint/{name}/Document

请求参数：

参数 是否必选 类型 可选值范围 说明
name 是 string ppt, pptx, pps, ppsx, pptm, potx, odp 新建文档的名称
data 否 file   创建PowerPoint文档所需数据。若不上传文档数据，则直接创建空白文档
inputPassword 否 string   所上传的文档的密码，没有则为null
password 否 string   新建文档的密码，没有则为null
storage 否 string   文档存储空间，使用冰蓝云配置的2G空间存贮文档，可设置为null
folder 否 string   存放新建文档的文件夹，没有则为null

Java代码示例：

import spire.cloud.powerpoint.sdk.*;
import spire.cloud.powerpoint.sdk.model.*;
import spire.cloud.powerpoint.sdk.api.DocumentApi;
import spire.cloud.pdf.sdk.ApiException;

import java.io.File;

public class createPptDocument {
    static String appId = "your id";
    static String appKey = "your key";
    static String baseUrl = "https://api.e-iceblue.cn";
    static Configuration configuration = new Configuration(appId, appKey, baseUrl);
    static DocumentApi documentApi = new DocumentApi(configuration);

    public static void main(String[] args) throws ApiException {
        String name = "createPptDocument.pptx";
        File data = new File("D:/inputFile/test.pptx");
        String inputPassword = null;
        String password = null;
        String storage = null;
        String folder = "input";
        Document response = documentApi.createPptDocument(name, data, inputPassword, password, storage, folder);
    }
}

接口方法3：createPptDocumentFromSource()基于现有文档创建PowerPoint文档

HTTP 请求方法：POST

请求URL：https://api.e-iceblue.cn/v1/powerpoint/ {name}/fromSource

请求参数：

参数 是否必选 类型 可选值范围 说明
name 是 string   新建文档名称
sourcePath 否 string ppt, pptx, pps, ppsx, pptm, potx, odp 模板文件的路径
sourcePassword 否 string   模板文件的密码，没有则为null
sourceStorage 否 string   模板文件的储存空间，没有则为null
password 否 string   新建文档密码，没有则为null
storage 否 string   文档存储空间，使用冰蓝云配置的2G空间存贮文档，可设置为null
folder 否 string   存放新建文档的文件夹，没有则为null

Java代码示例：

import spire.cloud.powerpoint.sdk.*;
import spire.cloud.powerpoint.sdk.model.*;
import spire.cloud.powerpoint.sdk.api.DocumentApi;
import spire.cloud.pdf.sdk.ApiException;

public class createPptDocumentFromSource {
    static String appId = "your id";
    static String appKey = "your key";
    static String baseUrl = "https://api.e-iceblue.cn";
    static Configuration configuration = new Configuration(appId, appKey, baseUrl);
    static DocumentApi documentApi = new DocumentApi(configuration);

    public static void main(String[] args) throws ApiException {
        String name = "createPptDocumentFromSource.pptx";
        String sourcePath = "source";
        String sourcePassword = null;
        String sourceStorage = null;
        String password = "test";
        String storage = null;
        String newFolder = "input";
        Document response = documentApi.createPptDocumentFromSource(name, sourcePath, sourcePassword, sourceStorage, password, storage, newFolder);
    }
}

接口方法4：setPptSlideSize()设置幻灯片尺寸

HTTP 请求方法：PUT

请求URL：https://api.e-iceblue.cn/v1/powerpoint/{name}/slideSize

请求参数：

参数 是否必选 类型 可选值范围 说明
name 是 string   原文档名称
folder 否 string   存放原文档的文件夹，没有则为null
storage 否 string   文档存储空间，使用冰蓝云配置的2G空间存贮文档，可设置为null
password 否 string   原文档密码，没有则为null
width 否 integer   幻灯片宽度。默认值为0
height 否 integer   幻灯片高度。默认值为0
sizeType 否 string OnScreen, LetterPaper, A4Paper, Slide35mm, Overhead, Banner, Custom, Ledger, A3Paper, B4IsoPaper, B5IsoPaper, B4JisPaper, B5JisPaper, HagakiCard, OnScreen16x9, OnScreen16x10 标准幻灯片尺寸类型
scaleType 否 string DoNotScale, EnsureFit, Maximize 标准幻灯片比例类型。默认值为DoNotScale

Java代码示例：

import spire.cloud.powerpoint.sdk.*;
import spire.cloud.powerpoint.sdk.model.*;
import spire.cloud.powerpoint.sdk.api.DocumentApi;
import spire.cloud.pdf.sdk.ApiException;

public class setPptSlideSize {
    static String appId = "your id";
    static String appKey = "your key";
    static String baseUrl = "https://api.e-iceblue.cn";
    static Configuration configuration = new Configuration(appId, appKey, baseUrl);
    static DocumentApi documentApi = new DocumentApi(configuration);

    public static void main(String[] args) throws ApiException {
        String name = "setPptSlideSize.pptx";
        String password = null;
        String storage = null;
        String folder = "input";
        Integer width = 800;
        Integer height = 600;
        String sizeType = null; //Available values : OnScreen, LetterPaper, A4Paper, Slide35mm, Overhead, Banner, Custom, Ledger, A3Paper, B4IsoPaper, B5IsoPaper, B4JisPaper, B5JisPaper, HagakiCard, OnScreen16x9, OnScreen16x10
        String scaleType = null; //Available values : DoNotScale, EnsureFit, Maximize; Default value : DoNotScale
        Document response = documentApi.setPptSlideSize(name, password, storage, folder, width, height, sizeType, scaleType);
    }
}

接口方法5：convertPpt()将PowerPoint文档另存为其他文档格式

HTTP 请求方法：POST

请求URL：https://api.e-iceblue.cn/v1/powerpoint/{name}/convert/{format}

请求参数：

参数 是否必选 类型 可选值范围 说明
name 是 string   原文档名称
format 是 string Pptx, Ppsx, Ppt, Pps, Odp, Pdf, Xps, Ps, Pcl 输出文档的格式
options 否 object {
"Format": "string"
}		 输出文档选项
folder 否 string   存放原文档的文件夹，没有则为null
storage 否 string   文档存储空间，使用冰蓝云配置的2G空间存贮文档，可设置为null
password 否 string   原文档密码，没有则为null

Java代码示例：

import spire.cloud.powerpoint.sdk.*;
import spire.cloud.powerpoint.sdk.model.*;
import spire.cloud.powerpoint.sdk.api.DocumentApi;
import spire.cloud.pdf.sdk.ApiException;

import java.io.File;

public class ConvertPpt {
    static String appId = "your id";
    static String appKey = "your key";
    static String baseUrl = "https://api.e-iceblue.cn";
    static Configuration configuration = new Configuration(appId, appKey, baseUrl);
    static DocumentApi documentApi = new DocumentApi(configuration);

    public static void main(String[] args) throws ApiException {

        String name = "convertPpt.pptx";
        String format = ExportFormat.PDF.toString(); // Odp、PPT、PPtx、PPS、PPSx、Pdf、Xps
        ExportOptions options = null;
        String password = null;
        String storage = null;
        String folder = "input";
        File response = documentApi.convertPpt(name, format, options, password, storage, folder);
    }
}

接口方法6：convertPptToPath()将PowerPoint文档另存为其他文档格式

HTTP 请求方法：PUT

请求URL：https://api.e-iceblue.cn/v1/powerpoint/{name}/convert/{format}

请求参数：

参数 是否必选 类型 可选值范围 说明
name 是 string   原文档名称
destFilePath 是 string   输出文档的存贮路径，如果省略该参数，则默认存到根目录
format 是 string Pptx, Ppsx, Ppt, Pps, Odp, Pdf, Xps, Ps, Pcl 输出文档的格式
options 否 object {
"Format": "string"
}		 输出文档选项
folder 否 string   存放原文档的文件夹，没有则为null
storage 否 string   文档存储空间，使用冰蓝云配置的2G空间存贮文档，可设置为null
password 否 string   原文档密码，没有则为null

Java代码示例：

import spire.cloud.powerpoint.sdk.*;
import spire.cloud.powerpoint.sdk.model.*;
import spire.cloud.powerpoint.sdk.api.DocumentApi;
import spire.cloud.pdf.sdk.ApiException;

public class convertPptToPath {
    static String appId = "your id";
    static String appKey = "your key";
    static String baseUrl = "https://api.e-iceblue.cn";
    static Configuration configuration = new Configuration(appId, appKey, baseUrl);
    static DocumentApi documentApi = new DocumentApi(configuration);

    public static void main(String[] args) throws ApiException {
        String name = "convertPptToPath.pptx";
        String format = ExportFormat.PPTX.toString(); // Odp、PPT、PPtx、PPS、PPSx、Pdf、Xps
        ExportOptions options = null;
        String password = null;
        String storage = null;
        String folder = "input";
        String destFilePath = "output/convertPptToPath_out.pptx";
        documentApi.convertPptToPath(name, destFilePath, format, options, password, storage, folder);
    }
}

接口方法7：splitPpt()将PowerPoint文档每一页拆分为图片

HTTP 请求方法：POST

请求URL：https://api.e-iceblue.cn/v1/powerpoint/{name}/split

请求参数：

参数 是否必选 类型 可选值范围 说明
name 是 string   原文档名称
format 否 string Jpeg, Png, Gif, Bmp, Pptx, Ppsx, Ppt, Pps, Odp, Pdf, Xps, Ps, Pcl, Svg 输出文档的格式。默认值为Jpeg
options 否 object {
"Format": "string"
}		 输出文档选项
width 否 integer   图片的宽度
height 否 integer   图片的高度
to 否 integer   需拆分的末尾幻灯片编号。如果未指定，则拆分到PowerPoint文档的最后一张幻灯片结束
from 否 integer   需拆分的起始幻灯片编号。如果未指定，则拆分从PowerPoint文档的第一张幻灯片开始
destFolder 否 string   用于储存图片的文件夹。 如果未指定，则储存到与原文档相同的文件夹
folder 否 string   存放原文档的文件夹，没有则为null
storage 否 string   文档存储空间，使用冰蓝云配置的2G空间存贮文档，可设置为null
password 否 string   原文档密码，没有则为null

Java代码示例：

import spire.cloud.powerpoint.sdk.*;
import spire.cloud.powerpoint.sdk.model.*;
import spire.cloud.powerpoint.sdk.api.DocumentApi;
import spire.cloud.pdf.sdk.ApiException;

public class splitPpt {
    static String appId = "your id";
    static String appKey = "your key";
    static String baseUrl = "https://api.e-iceblue.cn";
    static Configuration configuration = new Configuration(appId, appKey, baseUrl);
    static DocumentApi documentApi = new DocumentApi(configuration);

    public static void main(String[] args) throws ApiException {
        String name = "splitPpt.pptx";
        ExportOptions options = null;
        String format = SlideExportFormat.SVG.toString(); // JPEG PNG GIF BMP PPTX PPSX PPT PPS ODP PDF XPS PS PCL SVG
        Integer width = 400;
        Integer height = 300;
        Integer from = 3;
        Integer to = 6;
        String destFolder = "output";
        String password = null;
        String storage = null;
        String folder = "input";
        SplitDocumentResult response = documentApi.splitPpt(name, options, format, width, height, to, from, destFolder, password, storage, folder);
    }
}
back to top