You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/documentation/src/content/docs/integration/deployment/services/auth-service.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ When a request comes from a client with an account known to your local instance
32
32
33
33
When a request comes from a client registered with another instance of Rafiki, the `auth` service resolves the client's key endpoint (for example, `https://wallet.example.com/alice/jwks.json`) to retrieve the client's public keys, then filters out the correct key using the key id (`kid`) in the client's signature.
34
34
35
-
Review the <LinkOuthref="https://openpayments.dev/introduction/client-keys/">Open Payments documentation</LinkOut> for more information about client keys.
35
+
Review the <LinkOuthref="https://openpayments.dev/identity/client-keys/">Open Payments documentation</LinkOut> for more information about client keys.
36
36
37
37
## Identity provider (IdP)
38
38
@@ -44,7 +44,7 @@ You must integrate with an [IdP](/integration/requirements/open-payments/idp) wh
44
44
Rafiki’s [`frontend`](/integration/deployment/services/frontend-service) service requires an IdP for authentication and user management of your [Rafiki Admin](/admin/admin-user-guide) users. Out of the box, Rafiki uses Ory Kratos, a cloud-based user management system. Kratos is for internal use only and **cannot** be used as your customer-facing Open Payments authorization server.
45
45
:::
46
46
47
-
For more information about interactive grants and how they work with identity providers, review the [Identity Provider](/integration/requirements/open-payments/idp) page and the <LinkOuthref="https://openpayments.dev/introduction/grants/">Grant negotiation and authorization</LinkOut> page in the Open Payments docs.
47
+
For more information about interactive grants and how they work with identity providers, review the [Identity Provider](/integration/requirements/open-payments/idp) page and the <LinkOuthref="https://openpayments.dev/identity/grants/">Grant negotiation and authorization</LinkOut> page in the Open Payments docs.
Copy file name to clipboardExpand all lines: packages/documentation/src/content/docs/integration/deployment/services/backend-service.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ You must also set the environment variables for the `backend` service.
29
29
30
30
The `backend` service exposes the Open Payments APIs, which are auth-protected using an opinionated version of the Grant Negotiation and Authorization Protocol (GNAP). Review the [`auth`](/integration/deployment/services/auth-service) service page for more details about grant authorization and authentication.
31
31
32
-
The `backend` service allows you to manage Open Payments <LinkOuthref="https://openpayments.dev/introduction/op-concepts/#incoming-payment">incoming payments</LinkOut>, <LinkOuthref="https://openpayments.dev/introduction/op-concepts/#quote">quotes</LinkOut>, and <LinkOuthref='https://openpayments.dev/introduction/op-concepts/#outgoing-payment'>outgoing payments</LinkOut>. Quotes and outgoing payments call the ILP connector, described in the next section, to send ILP packets. Quoting sends unfulfillable probe packets, for example to determine a transaction’s cost before executing the payment. Outgoing payments send packets as part of executing the payment.
32
+
The `backend` service allows you to manage Open Payments <LinkOuthref="https://openpayments.dev/concepts/resources/#incoming-payment">incoming payments</LinkOut>, <LinkOuthref="https://openpayments.dev/concepts/resources/#quote">quotes</LinkOut>, and <LinkOuthref='https://openpayments.dev/concepts/resources/#outgoing-payment'>outgoing payments</LinkOut>. Quotes and outgoing payments call the ILP connector, described in the next section, to send ILP packets. Quoting sends unfulfillable probe packets, for example to determine a transaction’s cost before executing the payment. Outgoing payments send packets as part of executing the payment.
Copy file name to clipboardExpand all lines: packages/documentation/src/content/docs/integration/playground/overview.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -331,7 +331,7 @@ The sequence of steps outlined below corresponds to the interactions depicted in
331
331
332
332
:::note
333
333
334
-
You have to go through an interaction flow by selecting the `redirect` link in the grant request's response. More information about the interaction flow can be found <LinkOuthref='https://openpayments.dev/introduction/grants/'>here</LinkOut>.
334
+
You have to go through an interaction flow by selecting the `redirect` link in the grant request's response. More information about the interaction flow can be found <LinkOuthref='https://openpayments.dev/identity/grants/'>here</LinkOut>.
Copy file name to clipboardExpand all lines: packages/documentation/src/content/docs/integration/requirements/open-payments/idp.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ We provide Ory Kratos, a cloud-based user management system, for the identity an
24
24
25
25
In Open Payments, grants indicate a resource owner, such as an account holder, has given a piece of software, such as a mobile app, permission (consent) to act on their behalf.
26
26
27
-
Rafiki's implementation of an Open Payments authorization server requires that consent is collected via an interactive grant before an <LinkOuthref="https://openpayments.dev/introduction/op-concepts/#outgoing-payment">outgoing payment</LinkOut> request is issued. A grant is interactive when explicit interaction by a resource owner (for example, the software's end user) is required to approve or deny the grant. Tapping an _Approve_ button to authorize a payment is an example of an explicit interaction.
27
+
Rafiki's implementation of an Open Payments authorization server requires that consent is collected via an interactive grant before an <LinkOuthref="https://openpayments.dev/concepts/resources/#outgoing-payment">outgoing payment</LinkOut> request is issued. A grant is interactive when explicit interaction by a resource owner (for example, the software's end user) is required to approve or deny the grant. Tapping an _Approve_ button to authorize a payment is an example of an explicit interaction.
28
28
29
29
Interactive grants can be optional for incoming payments and quotes; however, they're enabled by default in Rafiki (the `LIST_ALL_ACCESS_INTERACTION` environment variable is `true`). When a grant request includes a `list-all` action for incoming payments and quotes, the request requires interaction. The `list-all` action is used when the client asks to list resources that it did not create.
30
30
@@ -33,7 +33,7 @@ If `LIST_ALL_ACCESS_INTERACTION` is `false`, you can still force interactive gra
33
33
-`QUOTE_INTERACTION`
34
34
-`INCOMING_PAYMENT_INTERACTION`
35
35
36
-
See the <LinkOuthref="https://openpayments.dev/introduction/grants/">Open Payments documentation</LinkOut> for more information on grant negotiation and authorization.
36
+
See the <LinkOuthref="https://openpayments.dev/identity/grants/">Open Payments documentation</LinkOut> for more information on grant negotiation and authorization.
Creating a public-private key pair for each wallet address is not required when integrating with Rafiki.
10
10
11
-
You only need to create key pairs for wallet addresses if you want to allow your account holders to use/be Open Payments clients under their wallet addresses. For more information, review the Open Payments documentation about <LinkOuthref="https://openpayments.dev/resources/glossary/#client">clients</LinkOut> and <LinkOuthref="https://openpayments.dev/introduction/client-keys/">client keys</LinkOut>.
11
+
You only need to create key pairs for wallet addresses if you want to allow your account holders to use/be Open Payments clients under their wallet addresses. For more information, review the Open Payments documentation about <LinkOuthref="https://openpayments.dev/resources/glossary/#client">clients</LinkOut> and <LinkOuthref="https://openpayments.dev/identity/client-keys/">client keys</LinkOut>.
Rafiki follows the <LinkOuthref='https://openpayments.dev'>Open Payments</LinkOut> standard to enable third-party clients to securely retrieve account information and initiate payments from your customers’ accounts with their consent. The standard describes a uniform way to create and manage grants and resources for <LinkOuthref='https://openpayments.dev/introduction/op-concepts/#resource-types'>incoming payments, quotes, and outgoing payments</LinkOut>.
9
+
Rafiki follows the <LinkOuthref='https://openpayments.dev'>Open Payments</LinkOut> standard to enable third-party clients to securely retrieve account information and initiate payments from your customers’ accounts with their consent. The standard describes a uniform way to create and manage grants and resources for <LinkOuthref='https://openpayments.dev/concepts/resources/#resource-types'>incoming payments, quotes, and outgoing payments</LinkOut>.
10
10
11
11
### Example use case - retrieve account information
12
12
@@ -16,16 +16,16 @@ Some of your customers use a third-party application that allows them to create
16
16
17
17
We strongly encourage you to familiarize yourself with the Open Payments standard. Extensive documentation is available on the <LinkOuthref="https://openpayments.dev">Open Payments</LinkOut> website. We recommend you start by reviewing all the pages within the _Intro to Open Payments_ section. Here are a few links to get you started.
@@ -35,4 +35,4 @@ Rafiki’s [`backend`](/integration/deployment/services/backend-service) service
35
35
36
36
## Rafiki's auth service
37
37
38
-
Rafiki’s [`auth`](/integration/deployment/services/auth-service) service is a reference implementation of an opinionated Open Payments authorization server. The authorization server is responsible for delegating authorization (via grants) to clients to use the Open Payments APIs, resolving <LinkOuthref="https://openpayments.dev/introduction/client-keys/">clients’ public keys</LinkOut> to authenticate and authorize incoming requests, and creating payments and quotes on the backend. Open Payments leverages the Grant Negotiation and Authorization Protocol (GNAP) for delegating authorization. You can learn more about the protocol by reviewing its <LinkOuthref="https://datatracker.ietf.org/doc/html/draft-ietf-gnap-core-protocol">specification</LinkOut>.
38
+
Rafiki’s [`auth`](/integration/deployment/services/auth-service) service is a reference implementation of an opinionated Open Payments authorization server. The authorization server is responsible for delegating authorization (via grants) to clients to use the Open Payments APIs, resolving <LinkOuthref="https://openpayments.dev/identity/client-keys/">clients’ public keys</LinkOut> to authenticate and authorize incoming requests, and creating payments and quotes on the backend. Open Payments leverages the Grant Negotiation and Authorization Protocol (GNAP) for delegating authorization. You can learn more about the protocol by reviewing its <LinkOuthref="https://datatracker.ietf.org/doc/html/draft-ietf-gnap-core-protocol">specification</LinkOut>.
0 commit comments