diff --git a/api-reference/charges/create.mdx b/api-reference/charges/create.mdx index f351bac..09e7627 100644 --- a/api-reference/charges/create.mdx +++ b/api-reference/charges/create.mdx @@ -5,9 +5,9 @@ api: "POST https://api.zebedee.io/v0/charges" ## Description -Creates a new [Charge](/docs/glossary#charge) / Payment Request in the Bitcoin Lightning Network, payable by any Lightning Network wallet. +Creates a new [Charge](/knowledge-base/glossary#charge) / Payment Request in the Bitcoin Lightning Network, payable by any Lightning Network wallet. -These payment requests are single-use, fixed-amount QR codes. If you're looking for multi-use and multi-amount payment requests you want [Static Charges](/api/static-charges/create/). +These payment requests are single-use, fixed-amount QR codes. If you're looking for multi-use and multi-amount payment requests you want [Static Charges](/api-reference/static-charges/create). ## Usage diff --git a/api-reference/charges/decode.mdx b/api-reference/charges/decode.mdx index f127809..d66c54b 100644 --- a/api-reference/charges/decode.mdx +++ b/api-reference/charges/decode.mdx @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/decode-invoice" ## Description -Decodes the inner properties of a given [Charge](/docs/glossary#charge) / Payment Request / Lightning Network invoice. +Decodes the inner properties of a given [Charge](/knowledge-base/glossary#charge) / Payment Request / Lightning Network invoice. ## Usage diff --git a/api-reference/charges/get.mdx b/api-reference/charges/get.mdx index a99adaf..5c4044c 100644 --- a/api-reference/charges/get.mdx +++ b/api-reference/charges/get.mdx @@ -5,7 +5,7 @@ api: "GET https://api.zebedee.io/v0/charges/{CHARGE_ID}" ## Description -Retrieves all information relating a specific [Charge](/docs/glossary#charge) / Payment Request. +Retrieves all information relating a specific [Charge](/knowledge-base/glossary#charge) / Payment Request. ## Usage diff --git a/api-reference/gamertag/create.mdx b/api-reference/gamertag/create.mdx index 1e57520..694975a 100644 --- a/api-reference/gamertag/create.mdx +++ b/api-reference/gamertag/create.mdx @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/gamertag/charges" ## Description -While you can use the [Send Payment to ZBD Gamertag](/api/gamertag/send) endpoint to make a direct Bitcoin payment to a given ZBD user, if for whatever reason you'd want to create a general Lightning Network Charge / Payment Request QR code, you can use this endpoint. +While you can use the [Send Payment to ZBD Gamertag](/api-reference/gamertag/send) endpoint to make a direct Bitcoin payment to a given ZBD user, if for whatever reason you'd want to create a general Lightning Network Charge / Payment Request QR code, you can use this endpoint. ## Usage diff --git a/api-reference/gamertag/get-gamertag.mdx b/api-reference/gamertag/get-gamertag.mdx index 3e1a516..366c3ec 100644 --- a/api-reference/gamertag/get-gamertag.mdx +++ b/api-reference/gamertag/get-gamertag.mdx @@ -5,11 +5,11 @@ api: "GET https://api.zebedee.io/v0/gamertag/user-id/{USER_ID}" ## Description -This API endpoint is the reverse of the [Get User ID for ZBD Gamertag](/api/gamertag/get-user-id) endpoint. Use this endpoint to get a given user's ZBD Gamertag. +This API endpoint is the reverse of the [Get User ID for ZBD Gamertag](/api-reference/gamertag/get-user-id) endpoint. Use this endpoint to get a given user's ZBD Gamertag. ## Usage -If you've got a User ID and you wish to find out that user's ZBD Gamertag, perhaps to then [send that user payments](/api/gamertag/send), you may use this endpoint. +If you've got a User ID and you wish to find out that user's ZBD Gamertag, perhaps to then [send that user payments](/api-reference/gamertag/send), you may use this endpoint. ## Configuration diff --git a/api-reference/gamertag/get.mdx b/api-reference/gamertag/get.mdx index b4f423d..dff39d6 100644 --- a/api-reference/gamertag/get.mdx +++ b/api-reference/gamertag/get.mdx @@ -9,7 +9,7 @@ In order to get data on payments sent to ZBD Gamertags, you can use this endpoin ## Usage -The idea here is to use the `transactionId` property returned from the [Send Payment to ZBD Gamertags](/api/gamertag/send) response, and use that ID to fetch the latest details of the given Payment. +The idea here is to use the `transactionId` property returned from the [Send Payment to ZBD Gamertags](/api-reference/gamertag/send) response, and use that ID to fetch the latest details of the given Payment. ## Configuration diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index e7993d2..250635a 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -15,7 +15,7 @@ ZBD offers a powerful REST API that supports Bitcoin Lightning Network nanotrans ## Guides & Walkthroughs -For detailed documentation, walkthroughs, and guides about how to best use the ZBD API head over to our [Documentation Portal](/docs/quick-start). +For detailed documentation, walkthroughs, and guides about how to best use the ZBD API head over to our [Documentation Portal](/docs/overview). ## Resources diff --git a/api-reference/keysend/send.mdx b/api-reference/keysend/send.mdx index fe0c6e0..e682b50 100644 --- a/api-reference/keysend/send.mdx +++ b/api-reference/keysend/send.mdx @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/keysend-payment" ## Description -Every Lightning Network node has a Public Key identifying it to the wider network. While most payments in the Lightning Network require Payment Requests ([Charges](/docs/glossary#charges)) QR codes to be created and then paid for, there is another type of payment known as `Spontaneous Payment` or `Keysend Payment` on a more technical note. +Every Lightning Network node has a Public Key identifying it to the wider network. While most payments in the Lightning Network require Payment Requests ([Charges](/knowledge-base/glossary#charges)) QR codes to be created and then paid for, there is another type of payment known as `Spontaneous Payment` or `Keysend Payment` on a more technical note. This endpoint exposes the ability to make payment directly to a Lightning Network node Public Key, without the need for a Payment Request / Charge. diff --git a/api-reference/lightning-address/send.mdx b/api-reference/lightning-address/send.mdx index 5c8906a..c39bf9b 100644 --- a/api-reference/lightning-address/send.mdx +++ b/api-reference/lightning-address/send.mdx @@ -9,13 +9,13 @@ Send Bitcoin payments directly to a Lightning Address. A Lightning Address is an internet identifier (akin to an email address -- `andre@zbd.gg`) that anyone can send Bitcoin Lightning Network payments to. Leverage this API to programmatically perform these payments. -To learn more about Lightning Address, check out our [Glossary](/docs/glossary) or [lightningaddress.com](lightningaddress.com). +To learn more about Lightning Address, check out our [Glossary](/knowledge-base/glossary) or [lightningaddress.com](https://lightningaddress.com). ## Usage As the creator of the Lightning Address open source standard, we believe this API to be the single most frictionless way of using Bitcoin today. -To learn about the many ways in which a Lightning Address could make sense for your application, game, or platform, [check out this in-depth guide on Lightning Addresses](/docs/guides/custom-lightning-address-app). +To learn about the many ways in which a Lightning Address could make sense for your application, game, or platform, [check out this in-depth guide on Lightning Addresses](/knowledge-base/guides/custom-lightning-address-app). ## Configuration diff --git a/api-reference/lightning-address/validate.mdx b/api-reference/lightning-address/validate.mdx index ecabd63..9ccdfc3 100644 --- a/api-reference/lightning-address/validate.mdx +++ b/api-reference/lightning-address/validate.mdx @@ -9,7 +9,7 @@ Not all internet identifiers are Lightning Addresses / compatible with the Light ## Usage -The idea behind this API endpoint is to verify whether an internet-indentifier (e.g. `user@domain.com`) is in fact a Lightning Address and NOT an email address. Once verified, use the [Send Lightning Address Payment](/api/lightning-address/send) to perform the transaction. +The idea behind this API endpoint is to verify whether an internet-indentifier (e.g. `user@domain.com`) is in fact a Lightning Address and NOT an email address. Once verified, use the [Send Lightning Address Payment](/api-reference/lightning-address/send) to perform the transaction. ## Configuration diff --git a/api-reference/payments/send.mdx b/api-reference/payments/send.mdx index a255e7b..6ff5733 100644 --- a/api-reference/payments/send.mdx +++ b/api-reference/payments/send.mdx @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/payments" ## Description -Pays a [Charge](/docs/glossary#charge) / Payment Request in the Bitcoin Lightning Network. This is one of the main APIs which allow you to pay any Lightning Network request. +Pays a [Charge](/knowledge-base/glossary#charge) / Payment Request in the Bitcoin Lightning Network. This is one of the main APIs which allow you to pay any Lightning Network request. The words `Charge`, `Payment Request`, and `Invoice` can be seen as equivalent in the context of requesting funds in Lightning Network. diff --git a/api-reference/static-charges/create.mdx b/api-reference/static-charges/create.mdx index 1a7d162..6d1e385 100644 --- a/api-reference/static-charges/create.mdx +++ b/api-reference/static-charges/create.mdx @@ -5,7 +5,7 @@ api: "POST https://api.zebedee.io/v0/static-charges" ## Description -Static Charges are static Payment Requests in the Bitcoin Lightning Network. Whereas [Charges](/api/charges/create) create fixed-amount and single-use Payment Requests that expire, Static Charges provide you a lot more flexibility & capabilities, including: +Static Charges are static Payment Requests in the Bitcoin Lightning Network. Whereas [Charges](/api-reference/charges/create) create fixed-amount and single-use Payment Requests that expire, Static Charges provide you a lot more flexibility & capabilities, including: - **Variable Amounts** -> Static Charges have both `minAmount` and `maxAmount` properties, allowing for variable amounts set by the payer. @@ -25,7 +25,7 @@ Use this API endpoint to create advanced Payment Requests on the Bitcoin Lightni You can create a `multi-use` Static Charge with a fixed amount too, simply by setting `minAmount` and `maxAmount` to the same amount. -To understand more use cases for Static Charges, [check our in-depth guide](/docs/static-charge). +To understand more use cases for Static Charges, [check our in-depth guide](/knowledge-base/guides/static-charges). ## Configuration diff --git a/api-reference/static-charges/get.mdx b/api-reference/static-charges/get.mdx index 322adc1..1d30cf2 100644 --- a/api-reference/static-charges/get.mdx +++ b/api-reference/static-charges/get.mdx @@ -5,7 +5,7 @@ api: "GET https://api.zebedee.io/v0/static-charges/{STATIC_CHARGE_ID}" ## Description -Retrieves all information relating to a specific [Static Charge](/docs/static-charge). +Retrieves all information relating to a specific [Static Charge](/knowledge-base/guides/static-charges). ## Usage diff --git a/docs/dashboard/projects/create.mdx b/docs/dashboard/projects/create.mdx index c9f624b..246e4fa 100644 --- a/docs/dashboard/projects/create.mdx +++ b/docs/dashboard/projects/create.mdx @@ -2,7 +2,7 @@ title: 'Create Project' --- -Projects are the gateway into using the [ZBD API](/docs/zebedee-api/overview). Each project comes with a unique API key and a Bitcoin Lightning wallet. With this API key, you can receive funds, make payments, and withdraw Bitcoin — the API makes it possible to handle everything programmatically. +Projects are the gateway into using the [ZBD API](/knowledge-base/zebedee-api/overview). Each project comes with a unique API key and a Bitcoin Lightning wallet. With this API key, you can receive funds, make payments, and withdraw Bitcoin — the API makes it possible to handle everything programmatically. 1. If you're not already there, navigate to the `Projects` page in the sidebar menu, or use the keyboard shortcut `a + g`. diff --git a/docs/dashboard/projects/sandbox.mdx b/docs/dashboard/projects/sandbox.mdx index 89b7203..9c9e943 100644 --- a/docs/dashboard/projects/sandbox.mdx +++ b/docs/dashboard/projects/sandbox.mdx @@ -44,9 +44,9 @@ You may top up as many times as you'd like. As is expected, Sandbox Projects have their own Sandbox APIs and API Keys. These APIs are identical to the Live APIs, except that they are not connected to mainnet Bitcoin Lightning Network. This means that you can test your integration without having to spend real money. -You can view all Sandbox APIs by heading over to the [Sandbox API Reference page](/api/sandbox/gamertag/send-payment). +You can view all Sandbox APIs by heading over to the [Sandbox API Reference page](/api-reference/gamertag/send-gamertag). -At the moment we have exposed the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api/sandbox/gamertag/send-payment) for testing purposes. We will be adding more Sandbox APIs in the future, including the ability to create Sandbox Charges and Static Charges, as well as send Sandbox Payments. +At the moment we have exposed the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api-reference/gamertag/send-gamertag) for testing purposes. We will be adding more Sandbox APIs in the future, including the ability to create Sandbox Charges and Static Charges, as well as send Sandbox Payments. **If you're looking to leverage any of the other ZBD Payment APIs, go through the Identity Verification Process and swap to a Live Project.** ## Sending Bitcoin to a Sandbox ZBD Gamertag[​](#sending-bitcoin-to-a-sandbox-zbd-gamertag "Direct link to heading") @@ -60,7 +60,7 @@ First of, start by copying the `Sandbox API Key` from your Project's _API tab_.
-Now that we have our Sandbox API Key, let's use the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api/sandbox/gamertag/send-payment) to send some _fake satoshis_ to our Sandbox Test User. +Now that we have our Sandbox API Key, let's use the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api-reference/gamertag/send-gamertag) to send some _fake satoshis_ to our Sandbox Test User. You may write your own HTTP client to do this test, but the simplest way is to use the _API Playground Module_ available in the [ZBD API Reference](https://docs.zbd.dev/api). On every API Reference page you will find a _ZBD API Playground Module_ on the right-hand side that you can use to directly test an API endpoint by providing it an API Key and a payload (if necessary). @@ -94,7 +94,7 @@ Click on the transaction to view the transaction details for more information ar To confirm that the _fake satoshis_ were indeed sent to the right Test User, head on over to the Test Users tab in your Project. -### You have just used the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api/sandbox/gamertag/send-payment) to send _fake satoshis_ to your Sandbox Test User.[​](#you-have-just-used-the-send-bitcoin-to-zbd-gamertag-sandbox-api-to-send-fake-satoshis-to-your-sandbox-test-user "Direct link to heading") +### You have just used the [**Send Bitcoin to ZBD Gamertag Sandbox API**](/api-reference/gamertag/send-gamertag) to send _fake satoshis_ to your Sandbox Test User.[​](#you-have-just-used-the-send-bitcoin-to-zbd-gamertag-sandbox-api-to-send-fake-satoshis-to-your-sandbox-test-user "Direct link to heading") ### Congratulations![​](#congratulations "Direct link to heading") diff --git a/docs/quick-start.mdx b/docs/overview.mdx similarity index 65% rename from docs/quick-start.mdx rename to docs/overview.mdx index 088cc10..2b2c420 100644 --- a/docs/quick-start.mdx +++ b/docs/overview.mdx @@ -1,5 +1,5 @@ --- -title: 'Quick Start' +title: 'Overview' --- @@ -15,16 +15,16 @@ We are thrilled you've chosen to leverage ZBD API to introduce next-gen payments # What is ZBD? -ZBD is a global fintech focused on developing payments solutions on top of Bitcoin's [Lightning Network](/docs/lightning-network) rails. Our technology stack is vast and supports all kinds of applications: Game Developers, Fintechs, Social Platforms, and AdTechs. +ZBD is a global fintech focused on developing payments solutions on top of Bitcoin's [Lightning Network](/knowledge-base/lightning-network) rails. Our technology stack is vast and supports all kinds of applications: Game Developers, Fintechs, Social Platforms, and AdTechs. Our Lightning Network-powered infrastructure enables secure and instant Bitcoin transactions, and allows for frictionless payments of any size at extremely low fees. We remove the compliance, regulatory, and technical lift associated with incorporating modern global payment infrastructure into the fabric of any digital experience. # Getting Started -Know what you want to build? [Sign up today for a ZBD Dev Dashboard account](https://dashboard.zebedee.io/signup) and get access to an API Key to get started with payments on the [ZBD API](/docs/zebedee-api/overview). +Know what you want to build? [Sign up today for a ZBD Dev Dashboard account](https://dashboard.zebedee.io/signup) and get access to an API Key to get started with payments on the [ZBD API](/knowledge-base/zebedee-api/overview). -You can use the REST API directly, or through one of the supported [Software Development Kits (SDK)](/docs/zebedee-api/sdks). Follow the detailed [ZBD Dev Dashboard product walkthrough](/docs/dashboard/signup) to set up your account and to understand the many parts of the ZBD product suite. +You can use the REST API directly, or through one of the supported [Software Development Kits (SDK)](/knowledge-base/zebedee-api/sdks). Follow the detailed [ZBD Dev Dashboard product walkthrough](/docs/dashboard/signup) to set up your account and to understand the many parts of the ZBD product suite. -New to Bitcoin or Lightning Network? [Learn more with our in-depth guides](/docs/lightning-network). +New to Bitcoin or Lightning Network? [Learn more with our in-depth guides](/knowledge-base/lightning-network). Want to earn some Bitcoin to get started? Download the [ZBD App](https://zbd.gg) and play games, participate in events, or listen to podcasts for Bitcoin rewards! \ No newline at end of file diff --git a/docs/zbd-shield/faq.mdx b/docs/zbd-shield/faq.mdx index 72c2a65..3b5a36a 100644 --- a/docs/zbd-shield/faq.mdx +++ b/docs/zbd-shield/faq.mdx @@ -2,7 +2,7 @@ ### What does ZBD Shield do?[​](#what-does-zbd-shield-do "Direct link to heading") -ZBD Shield helps protect you from malicious and/or fraudulent activity by acting as a middleman between your project and the [ZBD API](/docs/zebedee-api/overview). The product helps you take action against bad actors by preventing transactions on entities (ZBD Gamertags, IPs, ISPs, and Device IDs). +ZBD Shield helps protect you from malicious and/or fraudulent activity by acting as a middleman between your project and the [ZBD API](/knowledge-base/zebedee-api/overview). The product helps you take action against bad actors by preventing transactions on entities (ZBD Gamertags, IPs, ISPs, and Device IDs). ### What does it mean to "ban" or "allow" an entity?[​](#what-does-it-mean-to-ban-or-allow-an-entity "Direct link to heading") diff --git a/docs/glossary.mdx b/knowledge-base/glossary.mdx similarity index 100% rename from docs/glossary.mdx rename to knowledge-base/glossary.mdx diff --git a/docs/guides/custom-lightning-address-app.mdx b/knowledge-base/guides/custom-lightning-address-app.mdx similarity index 100% rename from docs/guides/custom-lightning-address-app.mdx rename to knowledge-base/guides/custom-lightning-address-app.mdx diff --git a/docs/guides/lightning-address.mdx b/knowledge-base/guides/lightning-address.mdx similarity index 100% rename from docs/guides/lightning-address.mdx rename to knowledge-base/guides/lightning-address.mdx diff --git a/docs/guides/nostr-relay.mdx b/knowledge-base/guides/nostr-relay.mdx similarity index 100% rename from docs/guides/nostr-relay.mdx rename to knowledge-base/guides/nostr-relay.mdx diff --git a/docs/guides/send-payment-to-ln-address-app.mdx b/knowledge-base/guides/send-payment-to-ln-address-app.mdx similarity index 100% rename from docs/guides/send-payment-to-ln-address-app.mdx rename to knowledge-base/guides/send-payment-to-ln-address-app.mdx diff --git a/docs/guides/static-charges.mdx b/knowledge-base/guides/static-charges.mdx similarity index 91% rename from docs/guides/static-charges.mdx rename to knowledge-base/guides/static-charges.mdx index 82c01b2..54cf7c5 100644 --- a/docs/guides/static-charges.mdx +++ b/knowledge-base/guides/static-charges.mdx @@ -9,7 +9,7 @@ title: 'Static Charges' # Static Charges -Static Charges are a type of Payment Request QR code in the Bitcoin Lightning Network that has some incredible characteristics and capabiltiies. Whereas [Charges](/api/charges/create) create `fixed-amount` and `single-use` Payment Requests that expire, [Static Charges](/api-reference/static-charges/create) provide you a lot more flexibility & capabilities, including: +Static Charges are a type of Payment Request QR code in the Bitcoin Lightning Network that has some incredible characteristics and capabiltiies. Whereas [Charges](/api-reference/charges/create) create `fixed-amount` and `single-use` Payment Requests that expire, [Static Charges](/api-reference/static-charges/create) provide you a lot more flexibility & capabilities, including: * **Variable Amounts** -> Static Charges have both `minAmount` and `maxAmount` properties, allowing for variable amounts set by the payer. * **Multi-use** -> By default Static Charges have no expiration time, making them usable for any N payers/payments. @@ -53,7 +53,7 @@ Please check out [ZBD Streamer](https://streamer.zebedee.io) to view this live i ### User Tips / Zaps / User-to-User Payments[​](#user-tips--zaps--user-to-user-payments "Direct link to heading") -Static Charges are great for tips or commonly referred to as “zaps”. It can also be used for user-to-user payments, since they are a static QR code. Though the best user experience for these use cases is a [Lightning Address](/api/lightning-address/send-payment). +Static Charges are great for tips or commonly referred to as “zaps”. It can also be used for user-to-user payments, since they are a static QR code. Though the best user experience for these use cases is a [Lightning Address](/api-reference/lightning-address/send). ### Deposits[​](#deposits "Direct link to heading") diff --git a/docs/lightning-network.mdx b/knowledge-base/lightning-network.mdx similarity index 100% rename from docs/lightning-network.mdx rename to knowledge-base/lightning-network.mdx diff --git a/docs/payins/charges.mdx b/knowledge-base/payins/charges.mdx similarity index 96% rename from docs/payins/charges.mdx rename to knowledge-base/payins/charges.mdx index d8df327..872888e 100644 --- a/docs/payins/charges.mdx +++ b/knowledge-base/payins/charges.mdx @@ -17,7 +17,7 @@ In order to receive Bitcoin through the Lightning Network using the ZBD API, you | **callbackUrl** | _String_ | The URL ZBD API will make a POST HTTP request to with information about the Charges's status updates. | | **expiresIn** | _Number_ | The desired expiration time for this Charge (in seconds). | -To create a Charge, use the [`/charges`](/api/charges/create) API (or leverage one of our SDKs) by passing the correct attributes: +To create a Charge, use the [`/charges`](/api-reference/charges/create) API (or leverage one of our SDKs) by passing the correct attributes: diff --git a/docs/payins/zbd-gamertag.mdx b/knowledge-base/payins/zbd-gamertag.mdx similarity index 86% rename from docs/payins/zbd-gamertag.mdx rename to knowledge-base/payins/zbd-gamertag.mdx index b0e2520..8f855e9 100644 --- a/docs/payins/zbd-gamertag.mdx +++ b/knowledge-base/payins/zbd-gamertag.mdx @@ -7,13 +7,13 @@ title: 'Request Lightning Charge for ZBD Gamertag'
-While you can use the [Send Bitcoin to ZBD Gamertag](/api/gamertag/send-payment) endpoint to make a direct payment to a ZBD user, if you want to create a regular Lightning Network Invoice / Charge QR code for that given user, you can do so using the [`/gamertag/charges`](/api/gamertag/create-charge) endpoint. +While you can use the [Send Bitcoin to ZBD Gamertag](/api-reference/gamertag/send) endpoint to make a direct payment to a ZBD user, if you want to create a regular Lightning Network Invoice / Charge QR code for that given user, you can do so using the [`/gamertag/charges`](/api-reference/gamertag/create) endpoint. In order to request Charges from a user's Gamertag you just need to make a simple API call with a payload like the example below. | Property | Status | Description | | --- | :-: | :-: | -| Endpoint | [`/gamertag/create-charge`](/api/gamertag/create-charge) | ZBD API endpoint to use. | +| Endpoint | [`/gamertag/create-charge`](/api-reference/gamertag/create) | ZBD API endpoint to use. | | HTTP Method | `POST` | The type of HTTP request to invoke. | | Authentication | `apikey` | How the API request is authenticated by ZBD Platform. | @@ -74,6 +74,6 @@ Alternatively you could rely on the Game's own Wallet as a form of escrow. You c Alice will effectively be paying the Game Wallet in this scenario. -Once payment is settled, you can use the [Send Bitcoin to ZBD Gamertag](/api/gamertag/send-payment) endpoint and send the same amount to **Bob**. When this second payment settles you can then transfer the sword asset inside the game. +Once payment is settled, you can use the [Send Bitcoin to ZBD Gamertag](/api-reference/gamertag/send) endpoint and send the same amount to **Bob**. When this second payment settles you can then transfer the sword asset inside the game. While this technically involves two transactions, it provides a bit more control to the Developer that wishes to manage the transfer of assets/in-game items a bit more closely and with more checks and balances in place. Both approaches are recommended. \ No newline at end of file diff --git a/docs/payouts/lightning-address.mdx b/knowledge-base/payouts/lightning-address.mdx similarity index 93% rename from docs/payouts/lightning-address.mdx rename to knowledge-base/payouts/lightning-address.mdx index 0d568ba..92d66b6 100644 --- a/docs/payouts/lightning-address.mdx +++ b/knowledge-base/payouts/lightning-address.mdx @@ -7,7 +7,7 @@ title: 'Send Bitcoin to Lightning Address'
-To send Bitcoin to a given Lightning Address, all you need to do is call the [Send Lightning Address Payment API](/api/lightning-address/send-payment) with a POST call providing the following properties: +To send Bitcoin to a given Lightning Address, all you need to do is call the [Send Lightning Address Payment API](/api-reference/lightning-address/send) with a POST call providing the following properties: | Property | Description | | --- | --- | diff --git a/docs/payouts/lightning-charges.mdx b/knowledge-base/payouts/lightning-charges.mdx similarity index 93% rename from docs/payouts/lightning-charges.mdx rename to knowledge-base/payouts/lightning-charges.mdx index 37afe96..aa4f1d4 100644 --- a/docs/payouts/lightning-charges.mdx +++ b/knowledge-base/payouts/lightning-charges.mdx @@ -7,7 +7,7 @@ title: 'Pay Lightning Network Charges'
-In order to make a payment against a Lightning Network Payment Request (a.k.a Lightning Invoices, or Charges), you simply have to use the [Send Payment API](/api/payments/send) endpoint. A Payment accepts the following attributes: +In order to make a payment against a Lightning Network Payment Request (a.k.a Lightning Invoices, or Charges), you simply have to use the [Send Payment API](/api-reference/lightning-address/send) endpoint. A Payment accepts the following attributes: | Property | Status | Description | | --- | :-: | --- | @@ -77,4 +77,4 @@ If the submitted request suceeds, you can expect a JSON API response that resemb ## Payment Updates[​](#payment-updates "Direct link to heading") -There are cases where Lightning Payments can `get stuck` in transit (e.g. a network node on the path to the payment's destination suddenly goes offline). ZBD aims to provide cutting edge Lightning Network infrastructure with high availability and liquidity. That said, due to the possibility of running into stuck payment cases, the recommended method of getting Payment updates is through the `callbackUrl` attribute. By providing a `callbackUrl` when making the Payment, the [ZBD API](/api/intro) is able to make a POST request to that URL and pass along Payment updates as they happen. \ No newline at end of file +There are cases where Lightning Payments can `get stuck` in transit (e.g. a network node on the path to the payment's destination suddenly goes offline). ZBD aims to provide cutting edge Lightning Network infrastructure with high availability and liquidity. That said, due to the possibility of running into stuck payment cases, the recommended method of getting Payment updates is through the `callbackUrl` attribute. By providing a `callbackUrl` when making the Payment, the [ZBD API](/api-reference/introduction) is able to make a POST request to that URL and pass along Payment updates as they happen. \ No newline at end of file diff --git a/docs/payouts/withdrawal-requests.mdx b/knowledge-base/payouts/withdrawal-requests.mdx similarity index 94% rename from docs/payouts/withdrawal-requests.mdx rename to knowledge-base/payouts/withdrawal-requests.mdx index 8218e50..6fac696 100644 --- a/docs/payouts/withdrawal-requests.mdx +++ b/knowledge-base/payouts/withdrawal-requests.mdx @@ -23,13 +23,13 @@ This is a great user experience between User and a Project (e.g. game or applica Withdrawal Requests are the exact opposite of a Charge. Whereas a Charge is a payment from a User to a Project, a Withdrawal Request can be understood as a payment from a Project to a User. In other words, a Charge is a QR code that accepts a Bitcoin payment while **a Withdrawal Request is a QR code that allows a User to claim Bitcoin**. -ZBD's Withdrawal Request capability is based on the [LNURL open-source specification](https://github.com/fiatjaf/lnurl-rfc), which provides a standard for easier communication between Wallets (users) and Projects, through the use of HTTP requests. A developer building upon ZBD's Withdrawal Requests functionality does not need to understand the underlying methodology and workflow of LNURL - the [ZBD API](/docs/zebedee-api/overview) abstracts away any complexities. Let's see how to do it. +ZBD's Withdrawal Request capability is based on the [LNURL open-source specification](https://github.com/fiatjaf/lnurl-rfc), which provides a standard for easier communication between Wallets (users) and Projects, through the use of HTTP requests. A developer building upon ZBD's Withdrawal Requests functionality does not need to understand the underlying methodology and workflow of LNURL - the [ZBD API](/knowledge-base/zebedee-api/overview) abstracts away any complexities. Let's see how to do it. If you've been able to create a ZBD Charge, then you will be able to create a ZBD Withdrawal Request easily. # Creating a Withdrawal Request -When creating a Withdrawal Request code to allow Lightning Wallets to withdraw funds from the Project (game or application) you must provide the following attributes to the [`/withdrawal-requests`](/api/withdrawal-requests/create) endpoint: +When creating a Withdrawal Request code to allow Lightning Wallets to withdraw funds from the Project (game or application) you must provide the following attributes to the [`/withdrawal-requests`](/api-reference/withdrawal-requests/create) endpoint: | Property | Status | Description | | --- | :-: | --- | @@ -125,4 +125,4 @@ Note that the Withdrawal Request is created in a `pending` state as it still has } ``` -To subscribe to updates on a specific Withdrawal Request, the recommended approach is to provide a `callbackUrl` property when creating that Withdrawal Request. Whenever there are updates to the Withdrawal Request (a payment was made, or it has expired) the [ZBD API](/docs/zebedee-api/overview) will make a POST request to the URL provided in `callbackUrl`, passing the Withdrawal Request updates as data in the request. \ No newline at end of file +To subscribe to updates on a specific Withdrawal Request, the recommended approach is to provide a `callbackUrl` property when creating that Withdrawal Request. Whenever there are updates to the Withdrawal Request (a payment was made, or it has expired) the [ZBD API](/knowledge-base/zebedee-api/overview) will make a POST request to the URL provided in `callbackUrl`, passing the Withdrawal Request updates as data in the request. \ No newline at end of file diff --git a/docs/payouts/zbd-gamertag.mdx b/knowledge-base/payouts/zbd-gamertag.mdx similarity index 97% rename from docs/payouts/zbd-gamertag.mdx rename to knowledge-base/payouts/zbd-gamertag.mdx index f29764e..d0feac0 100644 --- a/docs/payouts/zbd-gamertag.mdx +++ b/knowledge-base/payouts/zbd-gamertag.mdx @@ -23,7 +23,7 @@ In order to send payments directly to a user's Gamertag you just need to make an | Property | Status | Description | | --- | :-: | :-: | -| Endpoint | [`/gamertag/send-payment`](/api/gamertag/send-payment) | API endpoint to use. | +| Endpoint | [`/gamertag/send-payment`](/api-reference/gamertag/send) | API endpoint to use. | | HTTP Method | `POST` | The type of HTTP request to invoke. | | Authentication | `apikey` | How the API request is authenticated by ZBD Platform. | diff --git a/docs/zebedee-api/authentication.mdx b/knowledge-base/zebedee-api/authentication.mdx similarity index 80% rename from docs/zebedee-api/authentication.mdx rename to knowledge-base/zebedee-api/authentication.mdx index 1e1f9a7..f528749 100644 --- a/docs/zebedee-api/authentication.mdx +++ b/knowledge-base/zebedee-api/authentication.mdx @@ -2,7 +2,7 @@ title: 'Authentication' --- -The [ZBD API](/api/intro) uses API Keys to authenticate requests. Each of your Projects in the [ZBD Dev Dashboard](https://dashboard.zebedee.io) will have an unique API Key that allows for the management and control over that Project's Wallet. +The [ZBD API](/api-reference/introduction) uses API Keys to authenticate requests. Each of your Projects in the [ZBD Dev Dashboard](https://dashboard.zebedee.io) will have an unique API Key that allows for the management and control over that Project's Wallet. [Check this guide](/docs/dashboard/projects/api) to find your unique `API_KEY`, or to regenerate the API Key for a specific Project. diff --git a/docs/zebedee-api/error-handling.mdx b/knowledge-base/zebedee-api/error-handling.mdx similarity index 94% rename from docs/zebedee-api/error-handling.mdx rename to knowledge-base/zebedee-api/error-handling.mdx index dd838d2..a0342f9 100644 --- a/docs/zebedee-api/error-handling.mdx +++ b/knowledge-base/zebedee-api/error-handling.mdx @@ -35,7 +35,7 @@ As seen above, you are most likely to encounter the highlighted HTTP status code ## Error Messages[​](#error-messages "Direct link to heading") -To help identify the issue with your API requests, the error JSON response returned will include a **message** property that aims to be descriptive. Follow the details from the message, alongside the [API Reference](/api/intro) / [Documentation](/docs/quick-start) to resolve the issue. +To help identify the issue with your API requests, the error JSON response returned will include a **message** property that aims to be descriptive. Follow the details from the message, alongside the [API Reference](/api-reference/introduction) / [Documentation](/docs/overview) to resolve the issue. Example of an error message from the API: diff --git a/docs/zebedee-api/overview.mdx b/knowledge-base/zebedee-api/overview.mdx similarity index 60% rename from docs/zebedee-api/overview.mdx rename to knowledge-base/zebedee-api/overview.mdx index 22d45ce..5db5cab 100644 --- a/docs/zebedee-api/overview.mdx +++ b/knowledge-base/zebedee-api/overview.mdx @@ -9,7 +9,7 @@ title: 'Overview of ZBD API' -The ZBD API offers a robust RESTful API allowing for the quick integration of [Bitcoin Lightning Network](/docs/lightning-network) nanotransactions into any digital experience (e.g. apps, games, social platforms). ZBD API empowers apps and platforms with the ability to send and receive Bitcoin nearly instantaneously at practically zero-cost. +The ZBD API offers a robust RESTful API allowing for the quick integration of [Bitcoin Lightning Network](/knowledge-base/lightning-network) nanotransactions into any digital experience (e.g. apps, games, social platforms). ZBD API empowers apps and platforms with the ability to send and receive Bitcoin nearly instantaneously at practically zero-cost. Our API aims to provide developers an easy path to integrating Bitcoin by abstracting _any and all_ of the complexities of the underlying system (think: no blockchains, no liquidity management, no infrastructure concerns -> just an API away). @@ -17,6 +17,6 @@ The ZBD API exposes a REST interface with endpoints that return JSON responses. # API Reference -All ZBD API endpoints are documented on the [API Reference](/api/intro). This reference guide is a detailed technical document explaining each of the endpoints available in the ZBD API. +All ZBD API endpoints are documented on the [API Reference](/api-reference/introduction). This reference guide is a detailed technical document explaining each of the endpoints available in the ZBD API. -The API Reference also boasts a right-sidebar [API Module](/api/charges/create) which allows you to interact with the ZBD API directly from the browser with the click of a button. \ No newline at end of file +The API Reference also boasts a right-sidebar [API Module](/api-reference/charges/create) which allows you to interact with the ZBD API directly from the browser with the click of a button. \ No newline at end of file diff --git a/docs/zebedee-api/resources.mdx b/knowledge-base/zebedee-api/resources.mdx similarity index 83% rename from docs/zebedee-api/resources.mdx rename to knowledge-base/zebedee-api/resources.mdx index a1174f8..5a8d51a 100644 --- a/docs/zebedee-api/resources.mdx +++ b/knowledge-base/zebedee-api/resources.mdx @@ -8,9 +8,9 @@ When integrating ZBD API for payments capabilities in your system, it's importan We've made a set of these Utility APIs available in the API Reference: -* [BTC USD Exchange Rate](/api/utils/btc-usd) -> Fetches the latest price for 1 Bitcoin in USD -* [Is Supported Region](/api/utils/is-supported) -> Fetches whether a user is located in a region ZBD services are available -* [ZBD Production IPs](/api/utils/prod-ips) -> Fetches the static IP addresses for ZBD servers +* [BTC USD Exchange Rate](/api-reference/utils/btc-usd) -> Fetches the latest price for 1 Bitcoin in USD +* [Is Supported Region](/api-reference/utils/is-supported-region) -> Fetches whether a user is located in a region ZBD services are available +* [ZBD Production IPs](/api-reference/utils/api) -> Fetches the static IP addresses for ZBD servers ## External Resources[​](#external-resources "Direct link to heading") diff --git a/docs/zebedee-api/sdks.mdx b/knowledge-base/zebedee-api/sdks.mdx similarity index 100% rename from docs/zebedee-api/sdks.mdx rename to knowledge-base/zebedee-api/sdks.mdx diff --git a/mint.json b/mint.json index 500636e..51bcb9f 100644 --- a/mint.json +++ b/mint.json @@ -36,47 +36,73 @@ "name": "Discord", "url": "https://discord.gg/zbd" }, - "tabs": [ + "anchors": [ { + "icon": "terminal", "name": "API Reference", "url": "api-reference" + }, + { + "icon": "books", + "name": "Knowledge Base", + "url": "knowledge-base" } ], "navigation": [ { - "group": "Overview", + "group": "", "pages": [ - "docs/quick-start", - "docs/lightning-network", - "docs/glossary" + "docs/overview" + ] + }, + { + "group": "", + "pages": [ + "knowledge-base/lightning-network", + "knowledge-base/glossary" ] }, { "group": "ZBD API", "pages": [ - "docs/zebedee-api-reference/overview", - "docs/zebedee-api-reference/authentication", - "docs/zebedee-api-reference/error-handling", - "docs/zebedee-api-reference/sdks", - "docs/zebedee-api-reference/resources", + "knowledge-base/zebedee-api/overview", + "knowledge-base/zebedee-api/authentication", + "knowledge-base/zebedee-api/error-handling", + "knowledge-base/zebedee-api/sdks", + "knowledge-base/zebedee-api/resources", { "group": "Payouts", "pages": [ - "docs/payouts/lightning-address", - "docs/payouts/lightning-charges", - "docs/payouts/withdrawal-requests", - "docs/payouts/zbd-gamertag" + "knowledge-base/payouts/lightning-address", + "knowledge-base/payouts/lightning-charges", + "knowledge-base/payouts/withdrawal-requests", + "knowledge-base/payouts/zbd-gamertag" ] }, { "group": "Payins", "pages": [ - "docs/payins/charges", - "docs/payins/zbd-gamertag" + "knowledge-base/payins/charges", + "knowledge-base/payins/zbd-gamertag" ] } ] }, + { + "group": "Miscellaneous", + "pages": [ + "knowledge-base/guides/nostr-relay", + "knowledge-base/guides/lightning-address", + "knowledge-base/guides/static-charges" + ] + }, + { + "group": "Community", + "pages": [ + "knowledge-base/guides/custom-lightning-address-app", + "knowledge-base/guides/send-payment-to-ln-address-app" + ] + }, { "group": "Guides", "pages": [ @@ -90,26 +116,6 @@ "docs/zbd-login/advanced" ] }, - { - "group": "Miscellaneous", - "pages": [ - "docs/guides/nostr-relay", - "docs/guides/lightning-address", - "docs/guides/static-charges" - ] - }, - { - "group": "Community", - "pages": [ - "docs/guides/custom-lightning-address-app", - "docs/guides/send-payment-to-ln-address-app" - ] - } - ] - }, - { - "group": "Walkthroughs", - "pages": [ { "group": "Dev Dashboard", "pages": [