ポキドック 0.1.1

ポキドック 0.1.1

×

测试已测试✓
Lang语言 SwiftSwift
许可证 MIT
Released上次发布2017年2月
SwiftSwift 版本3.0
SPM支持 SPM✗

维护者 PokitDok。

ポキドック 0.1.1

Pokitdok 平台 API 客户端（Swift版）

使用 Swift 3 构建，使使用 Pokitdok API 的开发和使用更加便捷。

资源

安装

手动安装

  • 终端中，进入您的项目目录，并将项目初始化为 git 仓库（如果尚未初始化）

    $ git init

  • Pokitdok 作为 git 子模块添加

    $ git submodule add https://github.com/pokitdok/pokitdok-swift.git

  • 新创建的 pokitdok-swift 文件夹打开后，将 pokitdok.xcodeproj 拖入应用程序 Xcode 项目的 Project Navigator 中，并将其放置在蓝色 Xcode 项目图标下的任何位置。

  • Project Navigator 中选择 pokitdok.xcodeproj，并验证部署目标与您的应用程序目标的部署目标是否匹配。

  • 接下来，在 Project Navigator 中选择您的应用程序项目（蓝色项目图标），导航到“通用”面板，并找到“嵌入的二进制文件”部分。

  • 在“嵌入的二进制文件”部分下点击 + 按钮。

  • 选择最上面的 pokitdok.framework 并添加。

快速入门

import pokitdok

let client_id = "<your-client-id>"
let client_secret = "<your-client-secret>"
let client = try Pokitdok(clientId: client_id, clientSecret: client_secret)

let elig_args = [
    "member": [
        "birth_date" : "1970-01-25",
        "first_name" : "Jane",
        "last_name" : "Doe",
        "id": "W000000000"
    ],
    "provider": [
        "first_name" : "JEROME",
        "last_name" : "AYA-AY",
        "npi" : "1467560003"
    ],
    "trading_partner_id": "MOCKPAYER"
] as [String : Any]

let elig_response = try client.eligibility(params: elig_args)

发送请求

客户端提供了一些发送 API 请求的选项。针对每个 API 都有高级函数可供方便使用。如果您的应用程序喜欢以较低层级与 API 交互，您可以选择使用通用请求方法或围绕它构建的 http 方法别名。

// A low level "request" method is available
let act_response = try client.request(path: "/activities", method: "GET")

let elig_args = [
    "member": [
        "birth_date" : "1970-01-25",
        "first_name" : "Jane",
        "last_name" : "Doe",
        "id": "W000000000"
    ],
    "provider": [
        "first_name" : "JEROME",
        "last_name" : "AYA-AY",
        "npi" : "1467560003"
    ],
    "trading_partner_id": "MOCKPAYER"
] as [String : Any]
let elig_response = try client.request(path: "/eligibility/", method: "POST", params: elig_args)

// Convenience methods are available for the commonly used http methods built around the request method
let act_response = try client.get(path: "/activities")

let elig_args = [
    "member": [
        "birth_date" : "1970-01-25",
        "first_name" : "Jane",
        "last_name" : "Doe",
        "id": "W000000000"
    ],
    "provider": [
        "first_name" : "JEROME",
        "last_name" : "AYA-AY",
        "npi" : "1467560003"
    ],
    "trading_partner_id": "MOCKPAYER"
] as [String : Any]
let elig_response = try client.post(path: "/eligibility/", params: elig_args)

// Higher level functions are also available to access the APIs
let act_response = try client.activities()

let elig_args = [
    "member": [
        "birth_date" : "1970-01-25",
        "first_name" : "Jane",
        "last_name" : "Doe",
        "id": "W000000000"
    ],
    "provider": [
        "first_name" : "JEROME",
        "last_name" : "AYA-AY",
        "npi" : "1467560003"
    ],
    "trading_partner_id": "MOCKPAYER"
] as [String : Any]
let elig_response = try client.eligibility(params: elig_args)

身份验证

PokitDok API 的访问受 OAuth2 控制。大多数 API 都可以通过使用客户端凭证授权类型获得的访问令牌访问，您只需提供您的应用程序凭证，您就可以开始使用了。

import pokitdok

let client_id = "<your-client-id>"
let client_secret = "<your-client-secret>"
let client = try Pokitdok(clientId: client_id, clientSecret: client_secret)

脚注：强烈建议您不要将客户端ID和客户端密钥字符串直接嵌入iOS应用程序中，因为它们可能在那里容易遭到泄露。合适的替代方案是利用外部身份验证服务来验证您的用户，并请求一个访问令牌，然后将其返回到您的应用程序中以供使用。

更新客户端

如果您发现客户端存在错误或问题，请提交问题或随意创建一个拉取请求，我们会尽快处理该请求。

内部使用

更改合并后，请按照以下步骤重新部署客户端到我们的cocoapods发布中。

  • 使用适当的顺序标签号标记您的更改。
  • 更新pokitdok.podspec文件和README.md说明，使用新的版本号
  • 将您的新的标签合并并推送到master分支。
  • 从终端导航到项目目录，运行pod trunk push pokitdok.podspec以发布新版本