Translation disclaimer

Documentation is written in English and subsequently translated. This page, therefore, might not have the most up-to-date content. If any questions arise relating to the accuracy of the translated content, please refer to the English version of the page.

Menu

开始

开始使用我们 Access API 的初始步骤。


前提条件:向您的实施经理申请 Access Worldpay 凭证,并让自己熟悉我们的API 原则

设置头文件

设置头文件是集成的重要组成部分。头文件代表与您的 API 请求相关的元数据。

Copied!
Authorization: {your_credentials}
Content-Type: {API specific Content-Type header}
Accept: {API specific Accept header}
头文件模式
Authorization我们在 Access Worldpay 中使用 Authorization 头文件来识别您并进行身份验证。除非您在 TLS 上使用了客户端证书身份验证,否则您必须对发送到我们 API 的任何请求使用 Authorization 头文件。如果您必须使用此功能,请阅读关于通过 SSL/TLS 进行身份验证的参考指南。
Content-Type如果您发送的请求中包含请求正文,并且 HTTP 方法是 POSTPUT,则我们要求使用 Content-Type 头文件。
Accept我们使用 Accept 头文件来识别您正在使用哪个版本的 Fraudsight API。您必须对发送给 API 的任何请求使用 Accept 头文件。

查询根资源

我们的 API 可提供指向后续可用操作的链接,以便为您提供指导。

要探索并开始使用我们的 API,您必须首先查询根资源。这样就会返回 Access Worldpay 中的可用资源。

请求

用于测试 (Try)

GET https://try.access.worldpay.com/

用于 Live

GET https://access.worldpay.com/

注释:该请求不需要请求正文。

响应

您会在响应中收到所有我们可用的 API 资源。

Copied!
{
    "_links": {
        "payments:authorize": {
            "href": "https://try.access.worldpay.com/payments/authorizations"
        },
        "service:payments": {
            "href": "https://try.access.worldpay.com/payments"
        },
        "service:sessions": {
            "href": "https://try.access.worldpay.com/sessions"
        },
        "service:tokens": {
            "href": "https://try.access.worldpay.com/tokens"
        },
        "service:verifications/accounts": {
            "href": "https://try.access.worldpay.com/verifications/accounts"
        },
        "service:verifications/customers/3ds": {
            "href": "https://try.access.worldpay.com/verifications/customers/3ds"
        },
        "service:verifiedTokens": {
            "href": "https://try.access.worldpay.com/verifiedTokens"
        },
        "service:fraudsight": {
            "href": "https://try.access.worldpay.com/fraudsight"
        },
        "service:exemptions": {
            "href": "https://try.access.worldpay.com/exemptions"
        },
        "service:payouts": {
            "href": "https://try.access.worldpay.com/payouts"
        },
        "service:payment_pages": {
            "href": "https://try.access.worldpay.com/payment_pages"
        },
        "service:payments/alternative/direct": {
            "href": "https://try.access.worldpay.com/payments/alternative/direct"
        },
        "service:payments/alternative/action/paypal": {
            "href": "https://try.access.worldpay.com/payments/alternative/action/paypal"
        },
        "service:payments/alternative/action/ideal": {
            "href": "https://try.access.worldpay.com/payments/alternative/action/ideal"
        },
        "service:moneyTransfers": {
            "href": "https://try.access.worldpay.com/moneyTransfers"
        },
        "curies": [
            {
                "href": "https://try.access.worldpay.com/rels/payments/{rel}",
                "name": "payments",
                "templated": true
            }
        ]
    }
}
{
    "_links": {
        "payments:authorize": {
            "href": "https://access.worldpay.com/payments/authorizations"
        },
        "service:payments": {
            "href": "https://access.worldpay.com/payments"
        },
        "service:sessions": {
            "href": "https://access.worldpay.com/sessions"
        },
        "service:tokens": {
            "href": "https://access.worldpay.com/tokens"
        },
        "service:verifications/accounts": {
            "href": "https://access.worldpay.com/verifications/accounts"
        },
        "service:verifications/customers/3ds": {
            "href": "https://access.worldpay.com/verifications/customers/3ds"
        },
        "service:verifiedTokens": {
            "href": "https://access.worldpay.com/verifiedTokens"
        },
        "service:payouts": {
            "href": "https://access.worldpay.com/payouts"
        },
        "service:payments/alternative/direct": {
            "href": "https://access.worldpay.com/payments/alternative/direct"
        },
        "service:payments/alternative/action/paypal": {
            "href": "https://access.worldpay.com/payments/alternative/action/paypal"
        },
        "service:payments/alternative/action/ideal": {
            "href": "https://access.worldpay.com/payments/alternative/action/ideal"
          },
        "curies": [
            {
                "href": "https://access.worldpay.com/rels/payments/{rel}",
                "name": "payments",
                "templated": true
            }
        ]
    }
}

查询资源以探索特定的 API。该响应包含指向后续可用操作的链接和相应资源。

注释:在查询根资源时,您可能会注意到有些资源只在 Try 中可用,而在 Live 中不可用。这是因为 API 仍在开发中,仅供预览使用。

操作链接和 URI 资源

在集成到 Access Worldpay 时,我们强烈建议您从操作链接中获取 URI 资源链接。不要对 URI 资源链接进行硬编码,否则可能会变化并破坏集成。

什么是操作链接?

操作链接是在其中存储指向资源的 URI 链接的一个参数。

什么是 URI 资源链接?

URI 资源链接是指向您向其发送请求的资源的链接。

示例

Copied!
"payments:authorize": {
            "href": "https://try.access.worldpay.com/payments/authorizations"
}

在上例中,操作链接是:

payments:authorize

而 URI 资源链接是:

https://try.access.worldpay.com/payments/authorizations

该资源是支付授权资源。

DNS 白名单

将以下 URL 列入白名单:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

此外,您也可以将以下 IP 列入白名单:

Copied!
151.101.2.47
151.101.66.47
151.101.130.47
151.101.194.47

我们建议使用 DNS 白名单而不是显式 IP 白名单。

文档

以下文档涵盖了您的测试集成以及我们最新版本的 API。一旦您完成并测试了与选定 API 的集成,请参见我们的上线运行文档。