DEVDOCS-6233 | Content Refresh - "About Our APIs" #951
Conversation
Rewrote article to more closely resemble its equivalent for BigCommerce APIs
bc-Vince
requested review from
snaderiBC,
BC-EEspinosa,
bc-juliantran and
bc-terra
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
Less a suggestion and more a potential conversation. A benefit of this is that links within dev-center can be shortened to exclude the domain. It doesn't hurt to include the domain, but it is implied by the lack of domain and protocol info. This is doubly true for on-page anchors, which can be listed with just I'm willing to go either way on this, but we should make a decision and do what we can to be consistent about it. |
| | `Content-Type` | MIME types | The MIME type of the response, dependent on the extension of the endpoint that was requested | [HTTP Docs: Content-Type Header (MDN)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) | `application/json` | | ||
| | `Vary` | One or more request headers | Determines how to match future request headers to decide if a cached response can be used | [HTTP Docs: Vary Header (MDN)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Vary) | `Accept-Language` | | ||
| | `Allow` | One or more request methods | Specifies the request methods supported for a resource | [HTTP Docs: Allow Header (MDN)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Allow) | `GET, POST, HEAD, OPTIONS` | | ||
| | `Content-Language` | One or more locale codes | Lists the language locale code that indicates the content's intended audience | [HTTP Docs: Content-Language Header (MDN)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Language). | `en-US` | |
There was a problem hiding this comment.
Hard to read sentence (confidence: 5/7) retext-readability retext-readability
@bc-terra Relative links and anchors without the root domain make sense to me. I tried a new method for generating the markdown in this PR, and I missed the link formatting as a result. I'll update affected links in a new commit. |
| | Shopping Lists | Build and manage Shopping Lists for repeat purchases | [Yes](/b2b-edition/apis/rest-management/shopping-list) | [Yes](/b2b-edition/apis/rest-storefront/shopping-list) | | ||
| | Store Settings | Retrieve basic information from a storefront context, such as available currencies and order statuses | No | [Yes](/b2b-edition/apis/rest-storefront/store) | | ||
| | Super Admins | Assign your frontend sales representatives to Company accounts and initiate or end a Masquerade session | [Yes](/b2b-edition/apis/rest-management/super-admin) | [Yes](/b2b-edition/apis/rest-storefront/sales-rep) | | ||
| | Users | Add users to Company accounts and assign roles to specify Buyer Portal access permissions | [Yes](/b2b-edition/apis/rest-management/user) | [Yes](/b2b-edition/apis/rest-storefront/company/user) | |
There was a problem hiding this comment.
Hard to read sentence (confidence: 6/7) retext-readability retext-readability
docs/b2b-edition/about/index.mdx
Outdated
| | Shopping Lists | Build and manage Shopping Lists for repeat purchases | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-management/shopping-list) | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-storefront/shopping-list) | | ||
| | Store Settings | Retrieve basic information from a storefront context, such as available currencies and order statuses | No | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-storefront/store) | | ||
| | Super Admins | Assign your frontend sales representatives to Company accounts and initiate or end a Masquerade session | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-management/super-admin) | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-storefront/sales-rep) | | ||
| | Users | Add users to Company accounts and assign roles to specify Buyer Portal access permissions | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-management/user) | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-storefront/company/user) | |
There was a problem hiding this comment.
| | Users | Add users to Company accounts and assign roles to specify Buyer Portal access permissions | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-management/user) | [Yes](https://developer.bigcommerce.com/b2b-edition/apis/rest-storefront/company/user) | | |
| | Users | Add users to Company accounts and assign roles | [Yes](/b2b-edition/apis/rest-management/user) | [Yes](/b2b-edition/apis/rest-storefront/company/user) | |
| | `Strict-Transport-Security` | A collection of fields with specifications for loading the information using HTTPS | Informs the browser how long to wait before trying to access information again after it was not served over HTTPS | [HTTP Docs: Strict-Transport-Security Header (MDN)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Strict-Transport-Security) | `max-age=31536000; includeSubDomains` | | ||
| | `Content-Encoding` | One or more encoding formats | Allows API clients to request content to be compressed before being sent back in the response to an API request | [HTTP Docs: Content-Encoding Header (MDN)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Encoding) | `gzip` | | ||
| | `Via` | The protocol version and host | Lists the protocol and host to track messages forward and avoid request loops | [HTTP Docs: Via Header (MDN)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Via) | `1.1 google` | | ||
| | `Transfer-Encoding` | One or more encoding formats | Specifies the method used to transmit data between network nodes | [HTTP Docs: Transfer-Encoding Header (MDN)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Transfer-Encoding) | `chunked` | |
There was a problem hiding this comment.
Hard to read sentence (confidence: 6/7) retext-readability retext-readability
| | `X-Request-Id` | String | The unique identifier for the request associated with the response | \- | | ||
| | `Trace-Id` | String | The unique identifier for the request's trace, which can be used to monitor a request as it flows through distributed systems | \- | | ||
| | `X-Envoy-Upstream-Service-Time` | Number of milliseconds | The amount of time in which the upstream service processed the request | `68` | | ||
| | `Alt-Svc` | The protocol id, alternative authority, and max age | Designates a separate server to load the resource | `h3=":443"; ma=2592000` | |
There was a problem hiding this comment.
Hard to read sentence (confidence: 6/7) retext-readability retext-readability
| * Retrieving B2B order information | ||
| * Assigning user roles to B2B buyers | ||
|
|
||
| Unlike the other BigCommerce REST Management APIs, the B2B REST Management V3 APIs do not include store-specific data in the request path, such as the store hash. Instead the store specificity is contained within the server to server authToken used to authenticated the request. |
There was a problem hiding this comment.
authToken is misspelt retext-spell retext-spell
Rewrote article to more closely resemble its equivalent for BigCommerce APIs
DEVDOCS-6233
What changed?
Release notes draft
Anything else?
ping @bc-terra