This documentation page will run through how to properly create an API Account for Rebillia in BigCommerce, which permissions we need, at what level of permission, why we need each, and more global settings around creating an API Account
If you don't know how to navigate to creating a new API Account, please follow the BigCommerce support document here.
Once you are in the process of creating an API Account, follow these steps:
1. Under "Token type", select "v2/v3 API token".
2. Under "Name", enter "Rebillia".
3. Follow the below OAuth scope guide:
Scope Name | Permission Level | Explanation |
Content | Modify | We need the ability to modify your store content to inject our UI into your store. |
Checkout Content | Modify | We need access to read and create scripts on the checkout |
Customers | Modify | We need to be able to update customer address books, as well as (depending on business use case) control customer groups. |
Customer Login | None | Rebillia does not log in as a customer in the storefront. |
Information & Settings | None | Rebillia does not read/update store information/settings. |
Marketing | None | Rebillia does not interact with marketing tools. |
Orders | Modify | Rebillia needs to have the ability to create/update orders as well as the order statuses. |
Order Transactions | Modify | As Rebillia processes transactions, we need the ability to set/modify an order's transaction data. |
Create Payments | Create | Rebillia needs the ability to create payments for orders. |
Get Payment Methods | Read-only | Rebillia needs to see the list of available payment methods to connect properly in the checkout. |
Stored Payment Instruments | None | Rebillia does not interact with BigCommerce's stored payment instruments. We create our own instruments. |
Products | Modify | Rebillia needs access to inject and manage subscription options on products. |
Themes | None | Rebillia does not interact with BigCommerce themes. |
Carts | Modify | Rebillia needs to have the ability to control cart functionality when a subscription is added to the cart. |
Checkouts | Modify | Rebillia needs to have the ability to create a checkout object from carts, in order to complete the purchase process of a customer in checkout. |
Sites & Routes | None | Rebillia does not link to headless storefronts by default. |
Channel Settings | None | Rebillia does not modify marketplaces, POSs or channels on a BigCommerce account. |
Channel Listings | None | Rebillia does not interact with listing catalogues. |
Storefront API Tokens | Manage | Rebillia needs to be able to create storefront tokens for authentication processes. |
Storefront API Customer Impersonation Tokens | None | Rebillia does not need to impersonate a customer. |
Store Logs | None | Rebillia does not read BigCommerce store logs. |
Store Locations | None | Rebillia does not need store locations to operate. |
Store Inventory | Modify | Rebillia will work with store's inventory to manage subscription billing. |
Fulfillment Methods | None | Rebillia does not manage a store's fulfillment methods |
Order Fulfillment | None | Rebillia does not interact with order fulfillment processes. |
Metafield Ownership | None | Rebillia does not need to own metafields. |
Metafields Access | Standard | Rebillia does not require more than the normal access level. |