ACHeck21Checks 1.1.0

ACHeck21Checks 1.1.0

测试已测试
语言语言 Obj-CObjective C
许可证 Apache 2
发布上次发布2018年11月

Ryan Ackley维护。



 
依赖
AFNetworking~> 3
JSONModel~> 1.2
ISO8601~> 0.5
 

  • 作者
  • Ryan Ackley

ACHeck21Checks

未提供描述信息(由Swagger Codegen生成 https://github.com/swagger-api/swagger-codegen)

此ObjC包是自动由Swagger Codegen项目生成的

  • API版本:1.0.0
  • 包版本
  • 构建日期:2017-03-14T13:00:22.147-04:00
  • 构建包:class io.swagger.codegen.languages.ObjcClientCodegen

需求

SDK需要确保Xcode项目中启用ARC(自动引用计数)

安装与使用

使用CocoaPods从Gitbufh安装

将以下内容添加到Podfile中

pod 'ACHeck21Checks', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

要指定特定分支,添加, :branch => 'branch-name-here'

要指定特定提交,添加, :commit => '11aa22'

使用CocoaPods从本地路径安装

将SDK放入您的项目文件夹下(例如:/path/to/objc_project/Vendor/ACHeck21Checks),然后在Podfile中添加以下内容

pod 'ACHeck21Checks', :path => 'Vendor/ACHeck21Checks'

用法

导入以下内容

#import <ACHeck21Checks/ACHApiClient.h>
#import <ACHeck21Checks/ACHConfiguration.h>
// load models
#import <ACHeck21Checks/ACHAttachment.h>
#import <ACHeck21Checks/ACHCheck.h>
#import <ACHeck21Checks/ACHCheckQueryResult.h>
#import <ACHeck21Checks/ACHCreateAttachmentParams.h>
#import <ACHeck21Checks/ACHCreateCheckParams.h>
#import <ACHeck21Checks/ACHCredentials.h>
#import <ACHeck21Checks/ACHResourceLink.h>
#import <ACHeck21Checks/ACHReturn.h>
#import <ACHeck21Checks/ACHServerException.h>
#import <ACHeck21Checks/ACHSettlement.h>
#import <ACHeck21Checks/ACHValidateCheckParams.h>
#import <ACHeck21Checks/ACHValidationResult.h>
// load API classes for accessing endpoints
#import <ACHeck21Checks/ACHChecksApi.h>
#import <ACHeck21Checks/ACHLoginApi.h>

建议

在多线程环境下,建议为每个线程创建一个ApiClient实例以避免任何潜在的问题。

入门

请按照安装过程进行操作,然后运行以下内容:

ACHConfiguration *apiConfig = [ACHConfiguration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


NSString* *clientId = @"clientId_example"; // 
ACHCreateCheckParams* *values = [[ACHCreateCheckParams alloc] init]; //  (optional)

ACHChecksApi *apiInstance = [[ACHChecksApi alloc] init];

// Create a new Check transaction.
[apiInstance createCheckWithClientId:clientId
    values:values
              completionHandler: ^(ACHCheck* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

API端点文档

所有URI都是相对于https://gateway.acheck21.com/GlobalGateway

方法 HTTP请求 描述
ACHChecksApi createCheck PUT /api/v1/checks/{clientId} 创建一个新的Check交易。
ACHChecksApi getAttachments GET /api/v1/checks/{clientId}/{documentId}/attachments 检索特定Check的附件。通常每个支票只有一个结算。
ACHChecksApi getCheck GET /api/v1/checks/{clientId}/{documentId} 检索特定检查
ACHChecksApi getChecks GET /api/v1/checks/{clientId} 搜索属于某个商户账户的所有检查。
ACHChecksApi getReturns GET /api/v1/checks/{clientId}/{documentId}/returns 检索特定检查的退货。
ACHChecksApi getSettlements GET /api/v1/checks/{clientId}/{documentId}/settlements 检索特定检查的结算。通常每个支票最多有一个结算。
ACHChecksApi validateCheck POST /api/v1/checks/{clientId}/validate 验证支票。这通常涉及验证帐户是否存在,以及帐户上是否有未付款项(又称退票)。这是在全局网关的客户管理器中配置的。
ACHChecksApi voidCheck DELETE /api/v1/checks/{clientId}/{documentId} 删除特定检查交易。
ACHLoginApi getCurrentUser GET /api/v1/login 返回当前登录的有效用户名
ACHLoginApi login POST /api/v1/login 登录并生成用于未来授权的cookie。

模型文档

授权文档

基本认证

  • 类型: HTTP基本认证

作者