ClickSend v3 API 的官方 objc 库
这是 ClickSend 的官方 SDK。文档可以在这里找到:这里。
需求
- 免费注册 ClickSend 账户。
- 从 API 凭证 区域复制您的 API 密钥。
- SDK 需要 Xcode 项目中启用了 ARC (自动引用计数)。
安装 & 使用
使用 CocoaPods 从 GitHub 安装
将以下内容添加到 Podfile 中
pod 'ClickSendClient', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
为了指定特定的分支,请添加 , :branch => 'branch-name-here'
为了指定特定的提交,请添加 , :commit => '11aa22'
从本地路径使用CocoaPods安装
将SDK放置在您的项目文件夹下(例如:/path/to/objc_project/Vendor/ClickSendClient),然后在Podfile中添加以下内容
pod 'ClickSendClient', :path => 'Vendor/ClickSendClient'
使用方法
导入以下内容
#import <ClickSendClient/CSApiClient.h>
#import <ClickSendClient/CSDefaultConfiguration.h>
// load models
#import <ClickSendClient/CSAccount.h>
#import <ClickSendClient/CSAccountForgotPasswordVerify.h>
#import <ClickSendClient/CSAccountVerify.h>
#import <ClickSendClient/CSAddress.h>
#import <ClickSendClient/CSAttachment.h>
#import <ClickSendClient/CSContact.h>
#import <ClickSendClient/CSContactList.h>
#import <ClickSendClient/CSContactListImport.h>
#import <ClickSendClient/CSCreditCard.h>
#import <ClickSendClient/CSDateBefore.h>
#import <ClickSendClient/CSDeliveryIssue.h>
#import <ClickSendClient/CSDeliveryReceiptRule.h>
#import <ClickSendClient/CSEmail.h>
#import <ClickSendClient/CSEmailAddress.h>
#import <ClickSendClient/CSEmailCampaign.h>
#import <ClickSendClient/CSEmailFrom.h>
#import <ClickSendClient/CSEmailRecipient.h>
#import <ClickSendClient/CSEmailSMSAddress.h>
#import <ClickSendClient/CSEmailTemplateNew.h>
#import <ClickSendClient/CSEmailTemplateUpdate.h>
#import <ClickSendClient/CSFaxMessage.h>
#import <ClickSendClient/CSFaxMessageCollection.h>
#import <ClickSendClient/CSFields.h>
#import <ClickSendClient/CSFieldsFields.h>
#import <ClickSendClient/CSForgotPassword.h>
#import <ClickSendClient/CSForgotUsername.h>
#import <ClickSendClient/CSInboundFaxRule.h>
#import <ClickSendClient/CSInboundSMSRule.h>
#import <ClickSendClient/CSMmsCampaign.h>
#import <ClickSendClient/CSMmsMessage.h>
#import <ClickSendClient/CSMmsMessageCollection.h>
#import <ClickSendClient/CSPostLetter.h>
#import <ClickSendClient/CSPostPostcard.h>
#import <ClickSendClient/CSPostRecipient.h>
#import <ClickSendClient/CSResellerAccount.h>
#import <ClickSendClient/CSResellerAccountTransferCredit.h>
#import <ClickSendClient/CSSmsCampaign.h>
#import <ClickSendClient/CSSmsMessage.h>
#import <ClickSendClient/CSSmsMessageCollection.h>
#import <ClickSendClient/CSSmsTemplate.h>
#import <ClickSendClient/CSStrippedString.h>
#import <ClickSendClient/CSSubaccount.h>
#import <ClickSendClient/CSUploadFile.h>
#import <ClickSendClient/CSUrl.h>
#import <ClickSendClient/CSVoiceMessage.h>
#import <ClickSendClient/CSVoiceMessageCollection.h>
// load API classes for accessing endpoints
#import <ClickSendClient/CSAccountApi.h>
#import <ClickSendClient/CSAccountRechargeApi.h>
#import <ClickSendClient/CSContactApi.h>
#import <ClickSendClient/CSContactListApi.h>
#import <ClickSendClient/CSCountriesApi.h>
#import <ClickSendClient/CSDeliveryIssuesApi.h>
#import <ClickSendClient/CSDetectAddressApi.h>
#import <ClickSendClient/CSEmailDeliveryReceiptRulesApi.h>
#import <ClickSendClient/CSEmailMarketingApi.h>
#import <ClickSendClient/CSEmailToSmsApi.h>
#import <ClickSendClient/CSFAXApi.h>
#import <ClickSendClient/CSFAXDeliveryReceiptRulesApi.h>
#import <ClickSendClient/CSInboundFAXRulesApi.h>
#import <ClickSendClient/CSInboundSMSRulesApi.h>
#import <ClickSendClient/CSMMSApi.h>
#import <ClickSendClient/CSMasterEmailTemplatesApi.h>
#import <ClickSendClient/CSMmsCampaignApi.h>
#import <ClickSendClient/CSNumberApi.h>
#import <ClickSendClient/CSPostLetterApi.h>
#import <ClickSendClient/CSPostPostcardApi.h>
#import <ClickSendClient/CSPostReturnAddressApi.h>
#import <ClickSendClient/CSReferralAccountApi.h>
#import <ClickSendClient/CSResellerAccountApi.h>
#import <ClickSendClient/CSSMSApi.h>
#import <ClickSendClient/CSSMSDeliveryReceiptRulesApi.h>
#import <ClickSendClient/CSSearchApi.h>
#import <ClickSendClient/CSSmsCampaignApi.h>
#import <ClickSendClient/CSStatisticsApi.h>
#import <ClickSendClient/CSSubaccountApi.h>
#import <ClickSendClient/CSTimezonesApi.h>
#import <ClickSendClient/CSTransactionalEmailApi.h>
#import <ClickSendClient/CSTransferCreditApi.h>
#import <ClickSendClient/CSUploadApi.h>
#import <ClickSendClient/CSUserEmailTemplatesApi.h>
#import <ClickSendClient/CSVoiceApi.h>
#import <ClickSendClient/CSVoiceDeliveryReceiptRulesApi.h>
建议
建议在多线程环境中为每个线程创建一个ApiClient实例,以避免任何潜在的问题。
入门指南
请按照安装过程进行,然后执行以下命令
CSDefaultConfiguration *apiConfig = [CSDefaultConfiguration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
CSAccountApi *apiInstance = [[CSAccountApi alloc] init];
// Get account information
[apiInstance accountGetWithCompletionHandler:
^(NSString* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
文档
有关我们的SDK和REST API的文档可以在此处找到。
授权文档
基本认证
- 类型:HTTP基本认证