26557 - Developer Site - Document and demonstrate affiliation flows via API

.github/CODEOWNERS

@@ -8,6 +8,10 @@
 /web/site/content/en-CA/products/bn @thorwolpert
 /web/site/public/bn @thorwolpert
 
+## SBC Connect
+/web/site/content/en-CA/products/connect @thorwolpert @deetz99 @pwei1018 @bolyachevets @seeker25 @jxio @ochiu
+/web/site/public/connect @thorwolpert @deetz99 @pwei1018 @bolyachevets @seeker25 @jxio @ochiu
+
 ## MHR - Manufactured Home Registry
 /web/site/content/en-CA/products/mhr @doug-lovett
 /web/site/public/mhr @doug-lovett

web/site/app/tests/unit/utils/createContentNav.test.ts

@@ -56,6 +56,16 @@ const initialNavItems = [
 ]
 
 const formattedNavItems = [
+  {
+    children: [
+      { label: 'Overview', to: '/en-CA/products/br/overview' },
+      { label: 'Api', to: '/en-CA/products/br/api' },
+      { label: 'Examples', to: '/en-CA/products/br/examples' },
+      { label: 'Contact', to: '/en-CA/products/br/contact' }
+    ],
+    defaultOpen: true,
+    label: 'Business Registry'
+  },
   {
     children: [
       { label: 'Account Setup', to: '/en-CA/products/get-started/account-setup' },
@@ -67,15 +77,6 @@ const formattedNavItems = [
     ],
     defaultOpen: true,
     label: 'Get Started'
-  }, {
-    children: [
-      { label: 'Overview', to: '/en-CA/products/br/overview' },
-      { label: 'Api', to: '/en-CA/products/br/api' },
-      { label: 'Examples', to: '/en-CA/products/br/examples' },
-      { label: 'Contact', to: '/en-CA/products/br/contact' }
-    ],
-    defaultOpen: true,
-    label: 'Business Registry'
   }
 ]
 

web/site/app/utils/createContentNav.ts

@@ -18,6 +18,8 @@ export function createContentNav (navItems: NavItem[] | undefined) {
           }
         })
       }
+    }).sort((a, b) => {
+      return a.label?.localeCompare(b.label) // sort accordian items alphabetically
     })
   }) as AccordianNavItem[]
 }

web/site/content/en-CA/products/1.get-started/1.account-setup.md

@@ -8,7 +8,7 @@ description: 'Learn how to setup and begin using BC Registries Services and APIs
 Start using Service BC Connect application programming interfaces (APIs) by following these steps:
 
 1. Review the specifications in the Service BC Connect [API list](/products/get-started/apis-summary) and read the specifications to find the API(s) that meet your needs.
-2. [Set up an account](https://www2.gov.bc.ca/gov/content/employment-business/business/managing-a-business/permits-licences/news-updates/modernization-updates/modernization-resources#setupacct). You will need a BC Registries and Online Services premium account, with Pre-Authorized Debit (PAD) as the payment option before you can request access. If you already have an account, proceed to the next step.
+2. [Set up an account](https://www2.gov.bc.ca/gov/content/employment-business/business/managing-a-business/permits-licences/news-updates/modernization-updates/modernization-resources#setupacct). You will need a BC Registries and Online Services account in the <a href="https://sandbox.account.bcregistry.gov.bc.ca/decide-business"> sandbox environment </a> (BC Services Card users can create accounts right away, BCEID requires Staff approval) before you can request access. If you already have a sandbox account, proceed to the next step.
 3. Download, review and sign the API Terms of Use for the products you want to use:
    - <a href="/shared/api-terms-of-use.pdf" download="API-Terms-of-Use.pdf" target="_blank">API Terms of Use for all products except Short-Term Rental Registry</a>
    - <a href="/strr/strr-api-terms-of-use.pdf" download="STRR-API-Terms-of-Use.pdf" target="_blank">API Terms of Use for Short-Term Rental Registry</a>
@@ -19,14 +19,15 @@ Start using Service BC Connect application programming interfaces (APIs) by foll
    - In the body of the email, include your BC Registries and Online Services account number, along with your company’s account administrator’s name and email address.
 5. Upon completion of the access request, you will be issued with a sandbox environment API key with the appropriate access. They will be made available to you via your Account Administrator's BC Registries account dashboard.
 6. Validate your API key credentials by initiating a connection to the Sandbox environment. Also, test your API queries/calls in the Sandbox. Note that no fees will be charged for sandbox API keys or test transactions in the Sandbox environment only.
-7. After completing your testing, email a request for keys to BC Registries Production Environment.
+7. Ensure you have a production account, if not create one in the <a href="https://account.bcregistry.gov.bc.ca/decide-business"> production environment </a> (note BC Services Card will work right away, BCEID requires uploading an affidavit and approval from Staff): 
+8. After completing your testing, email a request for keys to BC Registries Production Environment.
    - Email your request for a production environment API key to **bcregistries@gov.bc.ca**.
    - Subject: Request for Service BC Connect API Production keys
    - In the body of your email, include your BC Registries account number, name and email of your account administrator.
-8. You will be issued with a production environment API key in your Account Dashboard in the <a href="https://www.bcregistry.gov.bc.ca/" target="_blank">BC Registry application</a> which can be accessed by your Account Administrator(s).
-9. Use the API key for your queries and submission of data. Review the [Detailed API documentation](/products/get-started/apis-summary) for more information about how the APIs work.
-10. Post your technical questions and join discussions in the BC <a href="https://discourse.onebc.ca/" target="_blank">Discourse forum</a> and be sure to watch for any announcements on API outages or new features being released.
-11. Attend the BC Registries API User Group meetings to get updates on specifications and releases or to discuss technical questions with developers. Email BCReg.engagement@gov.bc.ca to request a meeting invitation.
+9. You will be issued with a production environment API key in your Account Dashboard in the <a href="https://www.bcregistry.gov.bc.ca/" target="_blank">BC Registry application</a> which can be accessed by your Account Administrator(s).
+10. Use the API key for your queries and submission of data. Review the [Detailed API documentation](/products/get-started/apis-summary) for more information about how the APIs work.
+11. Post your technical questions and join discussions in the BC <a href="https://discourse.onebc.ca/" target="_blank">Discourse forum</a> and be sure to watch for any announcements on API outages or new features being released.
+12. Attend the BC Registries API User Group meetings to get updates on specifications and releases or to discuss technical questions with developers. Email BCReg.engagement@gov.bc.ca to request a meeting invitation.
 
 Questions? View our [About APIs](/products/get-started/about#frequently-asked-questions).
 

web/site/content/en-CA/products/1.get-started/2.apis-summary.md

@@ -19,6 +19,7 @@ Click on the Short Name to see more.
 
 | Short Name                              | Description                     |
 | --------------------------------------- | ------------------------------- |
+| [SBC Connect (formerly Auth)](/products/connect/overview)                 | SBC Connect Api (formerly Auth Api)                        |
 | [Pay](/products/pay/overview)                         | Pay Api                         |
 | [PPR](/products/ppr/overview)                          | Personal Property Registry API  |
 | [Business](/products/br/overview)               | Business Registry API           |
@@ -261,7 +262,10 @@ Updates of note to this page are recorded here.
     <td><p>Removed versions from the List of APIs table. Refer to the respective API's Version History section for version information.</p>
         <p>Removed Mock from the Environments table.</p>
         <p>Removed the Analytics Reports section.</p>
-        <p>Updated the Environments table SANDBOX and PRODCUCTION Base URLs.</p>
+        <p>Updated the Environments table SANDBOX and PRODUCTION Base URLs.</p>
+    </td>
+    <td>2025-04-03</td>
+    <td><p>Added SBC Connect.</p>
     </td>
   </tr>
 </table>

web/site/content/en-CA/products/connect/card.yml

@@ -1,7 +1,10 @@
 # Used to populate product card components
-name: Product Name Here
-description: Product Description Here
-badge: NEW | BETA etc
+name: SBC Connect
+description: Provides authentication/authorization services for the SBC Connect platform
+badge: Stable
 bulletPoints: 
-  - bullet point 1
-  - bullet point 2
+  - Create an account
+  - Manage account products
+  - Manage admin/coordinator/users
+  - Manage affiliations
+  - View API keys

web/site/content/en-CA/products/connect/overview.md

@@ -1,10 +1,97 @@
 ---
 title: 'Overview'
-description: 'SBC Connect Overview'
+description: 'SBC Connect API'
 ---
 
-# SBC Connect
+# SBC Connect API
 
 ---
 
-## Overview
+## Overview
+
+SBC Connect API (former Auth API) is a centralized authorization and authentication system designed to manage secure access across all partner applications. It ensures seamless user verification, enforces access controls, and protects sensitive resources through robust authentication mechanisms. By integrating with SBC Connect, partner apps can leverage a unified security framework, simplifying user management while maintaining compliance and security best practices.
+
+This specification focuses on creating business affiliations:
+- By passcode
+- By magic link
+- By delegation
+
+
+More to be added in the future.
+<br>
+
+::ButtonDownloadSpec{href="/connect/connect-spec.yaml" download="connect-spec.yaml"}
+::
+
+<br>
+<br>
+
+**Note:** All requests must include a **BC Registries issued API key** and an **Account ID**.
+
+---
+
+## View the API
+
+View the definition and select a path to try it out. To submit a request you will need an API key and an account ID, which are obtained as part of completing an access request. To set your session API key, click on the top, right AUTHORIZE button and under API Key Auth enter your key value. Click on AUTHORIZE, then OK.
+
+<a href="/en-CA/oas/connect" target="_blank"> View the API</a>
+
+
+
+## Date and Date Time Formats
+
+<table>
+  <tr>
+    <th>Type</th>
+    <th>Format</th>
+    <th>Example</th>
+  </tr>
+  <tr>
+    <td>Date</td>
+    <td>YYYY-MM-DD</td>
+    <td>2020-05-14</td>
+  </tr>
+  <tr>
+    <td>DateTime</td>
+    <td>YYYY-MM-DDThh:mm:ss[Z|+hh:mm]. Either +hh:mm (the time zone offset) or Z must be supplied. Default Z for Pacific time zone value.</td>
+    <td>2020-05-14T21:08:32Z</td>
+  </tr>
+</table>
+
+---
+
+## API Version History
+
+<table>
+  <tr>
+    <th>Date</th>
+    <th>Version</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>2025-04-11</td>
+    <td>1.0.0</td>
+    <td>Initial version</td>
+  </tr>
+</table>
+
+---
+
+## Additional Resources
+
+Postman collection of these calls is included in the [Business Registry](/products/br/overview) postman collection.
+
+## Page History
+
+Updates of note to this page are recorded here.
+
+<table>
+  <tr>
+    <th>Date</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>2025-04-03</td>
+    <td>Initial version</td>
+  </tr>
+</table>

web/site/content/en-CA/products/pay/card.yml

@@ -1,8 +1,8 @@
 # Used to populate product card components
 name: Platform Payment and Catalog Services
-description: The payment and catalog services for the sbc-connect platform
-badge: BETA
+description: The payment and catalog services for the SBC Connect platform
+badge: Stable
 bulletPoints: 
   - Pay for a service
   - Register services in the Catalog
-  - Transaction history
+  - Transaction history

web/site/nuxt.config.ts

@@ -1,5 +1,6 @@
 // https://nuxt.com/docs/api/configuration/nuxt-config
 import type { BreadcrumbLink } from '#ui/types'
+const localScalarUrl = process.env.NODE_ENV === 'development' ? 'http://localhost:3000' : ''
 export default defineNuxtConfig({
   devtools: { enabled: false },
   ssr: true,
@@ -75,7 +76,6 @@ export default defineNuxtConfig({
       'web-component',
       '/sbc/tos',
       '/products/bn',
-      'products/connect',
       '/1.get-started/3.api-access-request.md'
     ]
   },
@@ -94,47 +94,55 @@ export default defineNuxtConfig({
     configurations: [
       {
         spec: {
-          url: '/strr/platform.yaml'
+          url: `${localScalarUrl}/strr/platform.yaml`
         },
         pathRouting: {
           basePath: '/oas/strr'
         }
       },
       {
         spec: {
-          url: '/br/business-spec.yaml'
+          url: `${localScalarUrl}/connect/connect-spec.yaml`
+        },
+        pathRouting: {
+          basePath: '/oas/connect'
+        }
+      },
+      {
+        spec: {
+          url: `${localScalarUrl}/br/business-spec.yaml`
         },
         pathRouting: {
           basePath: '/oas/br'
         }
       },
       {
         spec: {
-          url: '/mhr/mhr-spec.yaml'
+          url: `${localScalarUrl}/mhr/mhr-spec.yaml`
         },
         pathRouting: {
           basePath: '/oas/mhr'
         }
       },
       {
         spec: {
-          url: '/pay/payment-spec.yaml'
+          url: `${localScalarUrl}/pay/payment-spec.yaml`
         },
         pathRouting: {
           basePath: '/oas/pay'
         }
       },
       {
         spec: {
-          url: '/ppr/ppr-spec.yaml'
+          url: `${localScalarUrl}/ppr/ppr-spec.yaml`
         },
         pathRouting: {
           basePath: '/oas/ppr'
         }
       },
       {
         spec: {
-          url: '/rs/regsearch-spec.yaml'
+          url: `${localScalarUrl}/rs/regsearch-spec.yaml`
         },
         pathRouting: {
           basePath: '/oas/rs'

web/site/package.json

@@ -2,7 +2,7 @@
   "name": "developer-connect-site",
   "private": true,
   "type": "module",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "scripts": {
     "build-check": "nuxt build",
     "build": "nuxt generate",
@@ -50,5 +50,5 @@
     "firebase-functions": "^4.9.0",
     "vuefire": "^3.1.24"
   },
-  "packageManager": "pnpm@8.7.6+sha1.a428b12202bc4f23b17e6dffe730734dae5728e2"
+  "packageManager": "pnpm@10.10.0"
 }