跳到主要内容
版本：v3

IOS

1 需要提供给我们的信息​

应用id IOS Bundle ID ， 例如 com.example.test

2 SDK接入​

由于苹果上架限制，app上架时请使用release架构

信息

release：仅含arm64架构，供审核或真机集成测试使用

debug：包含x86和arm64 架构，供模拟器集成测试使用

framework中包含动态库，集成到项目中时请选择 < Embed&Sign >

3 代码编写​

初始化SDK​

//引入 JuDianOpenApi.framework
#import <JuDianOpenApi/JuDianOpenApi.h>
初始化sdk
[JuDianOpenApi initWithToken:Token];

建议在AppDelegate中引入 必须在查词前完成注册激活 Token：查词平台后台注册成功后给到的token，与bundle id对应，如果提示错误，请检查项目bundle id与token是否对应

调用查词方法一​

查询词条，并在指定位置绘制结果视图 结果根据库查询返回​

参数 
@param text :查询的字词 
@param direction ：页面绘制方向  
@param origin ：页面绘制起点 
@param Width ：绘制页面的宽度 
@param Height ：绘制页面的最大高度
[JuDianOpenApi showExplainViewWithWord:text direction:direction origin:origin viewWidth:Width maxHeight:300];

调用查词方法二​

查询词条，返回结果数据，可以指定需要查询的类库​

参数: 
@param text :查询的词组 
@param fields :查询时指定的类库，不传或为空时，默认搜索配置的所有库 
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息

[JuDianOpenApi getExplainWithWord: text  fields:fields successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

success response:{
    code:200
    body:{
        font:{}//字体信息
        data:{}//词条数据
    }
}
failure response :{
    code:Integer //返回错误码
    body:{
        stauts:Integer //返回的错误码，为0时返回JuDianErrorInteger，具体错误可在SDK中进行查看
        detail:String //错误描述信息
    }
}

例如 语词库: yuci 百科库:baike 诗词库:shici 如果只查询百科 则传@[@"baike"] 同时查询语词与百科 则传@[@"baike",@"yuci"] 具体对应库名可以通过getAuthList 接口在app内获取，或在管理后台界面获取

查询词条，返回结果数据中包含的字体数据，可以使用一下方法注册使用​

font:
{
    fontName = 字体包FontName;
    ttf = 字体包 .ttf下载地址;
    woff = 字体包 .woff 下载地址;
}

CFErrorRef error;

CGDataProviderRef fontDataProvider = CGDataProviderCreateWithURL((__bridge CFURLRef)fontUrl);
CGFontRef fontRef = CGFontCreateWithDataProvider(fontDataProvider);
CGDataProviderRelease(fontDataProvider);
bool isSuccess = CTFontManagerRegisterGraphicsFont(fontRef, &error);
if(!isSuccess){
    //如果注册失败，则不使用
    CFStringRef errorDescription = CFErrorCopyDescription(error);
    NSLog(@"Failed to load font: %@", errorDescription);
    CFRelease(errorDescription);
}
CGFontRelease(fontRef);

UIFont * font = [UIFont fontWithName:fontName size:size];

获取配置的可查询书籍列表与数据库​

@param success 查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getAuthListSuccessBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

success response:{
    code:200
    body:{
        books:{}//返回的书籍数组
        fields:{}//返回的数据库数组
    }
}
failure response :{
    code:Integer //返回错误码
    body:{
        stauts:Integer //返回的错误码，为0时返回JuDianErrorInteger，具体错误可在SDK中进行查看
        detail:String //错误描述信息
    }
}

查询词条，返回结果数据，可以指定需要查询的书本id数组​

参数: 
@param text :查询的词组 
@param books :指定的书籍id 不传或为空时，默认搜索所有书籍数据
@param isFast :ture为快速检索，no为普通查询，快速检索时仅返回第一条匹配数据，普通查询时返回查询到的所有数据
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息

[JuDianOpenApi getExplainWithWord: text  books:books successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

例如 现代汉语大词典 id:40 辞海(第7版) id:98 如果只查询辞海 books:@[@"98"] 同时查询辞海与汉语大词典books:@[@"40",@"98"]或@[@40,@98]

获取单字信息​

@param word 查询的单字
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息

[JuDianOpenApi getStrokeOrderForWord:text successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

获取定性语信息,返回词条是否包含历史纪年、古今地名、中译英、英译中​

@param word 查询的单字
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息

[JuDianOpenApi cheackWordContainer:text successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

获取历史纪年​

@param word 查询的字词
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
  [JuDianOpenApi getHistoricalYearWithWord:text successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

获取古今地名​

@param word 查询的字词
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息

[JuDianOpenApi getAncientPlaceWithWord:text successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

英译中​

@param word 查询的字词
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息

[JuDianOpenApi getEnglishExplainWithWord:text successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

汉译英​

@param word 查询的字词
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getChineseToEnglishWithWordtext successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

词头模糊搜索：根据词头模糊搜索得到列表，通过headword再调用内容/释文接口。高亮里面包含headword、simplified​

@param word: 查询的词条
@param size: 一次查询返回的最大条目数，最大100
@param page: 请求的页码，0开始
@param books: 指定的书籍id 不传或为空时，默认搜索所有书籍数据
@param success: 查询成功并返回结果
@param failure: 查询失败返回错误信息
[JuDianOpenApi getBookExplainHeadword:word size:100 page:0 books:@[] successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

模糊搜索释文：根据释文模糊搜索得到列表，通过headword再调用内容/释文接口。高亮里面包含text、headword、simplified​

@param word: 查询的词条
@param size: 一次查询返回的最大条目数，最大100
@param page: 请求的页码，0开始
@param books: 指定的书籍id 不传或为空时，默认搜索所有书籍数据
@param success: 查询成功并返回结果
@param failure: 查询失败返回错误信息
[JuDianOpenApi getBookExplainExplain:word size:100 page:0 books:@[] successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

全文模糊搜索：会同时搜索词头和释文得到列表，通过headword再调用内容/释文接口。高亮里面包含text、headword、simplified​

@param word: 查询的词条
@param size: 一次查询返回的最大条目数，最大100
@param page: 请求的页码，0开始
@param books: 指定的书籍id 不传或为空时，默认搜索所有书籍数据
@param success: 查询成功并返回结果
@param failure: 查询失败返回错误信息
[JuDianOpenApi getBookExplainFuzzy:word size:100 page:0 books:@[] successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

根据笔顺搜索单字​

@param stroke: 笔顺 @{@"1":@"一",@"2":@"丨",@"3":@"丿",@"4":@"丶",@"5":@"乛"}
@param size: 分页大小
@param page: 页码
@param sort: 排序条件格式property,(asc|desc)，默认排序顺序为升序。支持多个排序条件。Default value : List [ "periodNum,ASC" ]
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getWordByStrokeOrder:text size:size page:page sort:sort successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

根据拼音搜索单字​

@param spell: 拼音数组["yì"]
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getWordBySpell:spell successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

根据部首搜索单字​

@param radical: 部首数组
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getWordByRadical:spell successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

通过干支获取年份​

@param ganzhi: 干支，例:甲子、甲申、辛丑等
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getYearByGanzhi:ganzhi successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

通过时期获取朝代​

@param period: 时期，例:五代十国、南北朝、战国等
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getDynastyByPeriod:period successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

通过时期朝代搜皇帝​

@param period: 时期，例:五代十国、南北朝、战国等
@param dynasty: 朝代，例:秦、楚、燕、赵等
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getEmperorByPeriod:period andDynasty:dynasty successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

查询语义​

@param word: 查询的语词
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getSemanticWithWord:word successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

获取诗词和诗人的相关标签，支持多个父标签Id搜索子标签，不传则搜索所有标签​

@param parentIds: 父标签Id ，number类型
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getPoetryTags:parentIds successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

诗词作品搜索​

@param tags: 支持标签需要搜索的标签，多标签搜索
@param appreciationAuthorId: 鉴赏作者Id，按需传值，可以不传
@param poetryAuthorId: 诗人Id，按需传值，可以不传
@param q: 搜索词
@param fields: 指定字段检索 Available values : POETRY_NAME, BRAND_NAME, POETRY, EXPLAIN, APPRECIATION  不传为全局
@param page: 页码
@param size: 页面的大小
@param sort: 默认使用 spell 拼音正序排序，同时还支持 viewTimes 浏览次数排序
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi searchPoetryWithTags:tags appreciationAuthorId:appreciationAuthorId poetryAuthorId:poetryAuthorId q:q fields:fields page:page size:size sort:sort successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

通过诗词id获取诗词详情信息，id参数通过搜索诗词获取​

@param poetryId: 诗词id
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getPoetryDetail:poetryId successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

通过诗词id获取诗词鉴赏信息，诗词id参数通过诗词详情获取​

@param poetryId: 诗词id
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getPoetryAppreciation:poetryId successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

诗人搜索，支持诗人名字，朝代，标签检索。默认使用 spell 拼音正序排序，同时还支持 viewTimes 浏览次数排序​

@param name: 诗人姓名
@param dynasty: 朝代
@param tags: 多标签搜索
@param page: 页码
@param size: 页面的大小
@param sort: 默认使用 spell 拼音正序排序，同时还支持 viewTimes 浏览次数排序
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi searchAuthorWithName:name dynasty:dynasty tags:tags page:page size:size sort:sort successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

通过诗人id获取诗人详情信息，id参数通过搜索诗人获取​

@param authorId: 诗人id
@param success :查询成功并返回结果
@param failure :查询失败返回错误信息
[JuDianOpenApi getAuthorDetail:authorId successBlock:(void(^)(NSDictionary * response))success failureBlock:(void(^)(NSDictionary * response))failure];

4 错误码说明​

SDK返回错误​

错误信息已请求返回的code和detail信息为主，下列的为当code = 0时，主要异常信息

typedef NS_ENUM(NSInteger, JuDianError) { //网络请求异常，code = 0时，status返回下列错误枚举
    JuDianErrorRequestTimeOut       =   -1001,  //请求超时
    JuDianErrorNetworkOffline       =   -1002,  //网络已断开,请检查本地网络连接
    JuDianErrorCertificateInvalid   =   -1003,  //证书异常,请检查本机系统时间
    JuDianErrorUndefined            =   -1009,  //暂时未定位问题,请稍后再试,有问题请联系:https://judian.jdapi.com
};


错误说明​

服务器返回的错误说明