-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
semi-final changes for Account Setup page content
- Loading branch information
Showing
1 changed file
with
22 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,17 +5,27 @@ description: 'Learn how to setup and begin using BC Registries Services and APIs | |
|
|
||
| # Account Setup | ||
|
|
||
| Start using BC Registries APIs in these steps: | ||
| Start using Service BC Connect application programming interfaces (APIs) by following these steps: | ||
|
|
||
| 1. View the [APIS services](/products/get-started/apis-summary) and read the specifications to find the ones that meet your needs. | ||
| 2. Create a production BC Registries' premium account, with Pre-Authorized Debit (PAD) as the payment option, to gain access. | ||
| 3. Download the <a href="shared/api-terms-of-use.pdf" download="API-Terms-of-Use.pdf" target="_blank">API Terms Of Use.pdf</a> and submit an access request email to **[email protected]**. Include these two in the email: | ||
| - Signed API Terms of Use. | ||
| - BC Registries account number. | ||
| 4. Upon completion of the access request, you will be issued with a sandbox environment API key with the appropriate access. Note that no fees will be charged for sandbox keys or test transactions. | ||
| 5. Test your provided sandbox environment API key (mandatory). | ||
| 6. If you're done testing, request a production environment API key to **[email protected]**. | ||
| 7. 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). | ||
| 8. Use the API key for your queries and submission of data. Be sure to watch for notifications in the <a href="https://discourse.onebc.ca/c/announcements/11" target="_blank">Discourse forum</a> for any announcements on API outages or new features being released. | ||
| 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' 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. | ||
| 3. Download, review and sign the <a href="shared/api-terms-of-use.pdf" download="API-Terms-of-Use.pdf" target="_blank">API Terms Of Use.pdf</a>. | ||
| 4. Email your access request for an API Sandbox key to BC Registries. | ||
| - Email **[email protected]** | ||
| - Subject: Request for Service BC Connect API sandbox keys | ||
| - Attach your signed API Terms of Use agreement in PDF format. | ||
| - In the body of the email, include your BC Registries account number, name and email of your account administrator. | ||
| 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. | ||
| - Email your request for a production environment API key to **[email protected]**. | ||
| - 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/c/announcements/11" 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 [email protected] to request a meeting invitation. | ||
|
|
||
| Questions? View our API [FAQS](/products/get-started/about#frequently-asked-questions). | ||
| Questions? View our [About APIs](/products/get-started/about#frequently-asked-questions). | ||
|
|
||
| New to Service BC Connect? Contact the [Digital Delivery - Partnerships team](https://docs.google.com/forms/d/e/1FAIpQLSe_wKlgPMm9lf1Gdb-TPBzKw1Kki-U57dk1ni1WnHuzAaESsQ/viewform) for help figuring out what services are right for you. | ||