-
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.
Merge pull request #161 from fareenr/fareenr---feature---API-FAQs-update
API FAQ Update 6.about.md
- Loading branch information
Showing
1 changed file
with
9 additions
and
36 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 |
---|---|---|
|
@@ -9,61 +9,34 @@ description: 'API Gateway About page. Useful information.' | |
|
||
1. [Are there resources that can help me set up a new Premium account?]{.font-semibold} | ||
|
||
BC Registries offers a <a href="https://www2.gov.bc.ca/assets/gov/employment-business-and-economic-development/business-management/permits-licences-and-registration/registries-guides/bc_registry_application_user_guide.pdf" target="_blank">BC Registry Application User Guide</a> that covers account creation. | ||
BC Registries offers a <a href="https://www2.gov.bc.ca/assets/gov/employment-business-and-economic-development/business-management/permits-licences-and-registration/registries-guides/bc_registry_application_user_guide.pdf" target="_blank">BC Registry Application User Guide</a> to help you create a new account in the modernized application. | ||
Please note that API services are only available to Premium account holders set up with | ||
pre-authorized debit as a payment option. | ||
pre-authorized debit as the payment method. | ||
|
||
[]{.my-4} <!--small line break, regular <br> is too large--> | ||
|
||
2. [What payment options are available to pay for transactions completed using an API?]{.font-semibold} | ||
|
||
Pre-authorized debit is the only payment method available to clients using APIs. | ||
Pre-authorized debit or Electronic Journal Vouchers for other Ministries are the main payment methods recommended for clients using APIs. | ||
|
||
[]{.my-4} | ||
|
||
3. [What if I already have an existing Premium account and I want to continue using this | ||
account to pay for filings/transactions with my BC OnLine account? (i.e., as a user, I’ll | ||
log in and sometimes submit name requests or complete filings).]{.font-semibold} | ||
3. [How can I access my organization's API access key code?]{.font-semibold} | ||
|
||
You will need to set up an additional Premium account for the APIs and use PAD to pay for | ||
this service. | ||
The API key is only available to Account Administrator(s) after logging in to the BC Registries application under Account Information - Developer Tools. You may want to add a developer in the account administrator role, if they need access to the API key code. | ||
|
||
[]{.my-4} | ||
|
||
4. [What if I am using BCeID to login and I can only have one admin on an account? How | ||
can I pay with my BC OnLine account as a user and also pay using PAD for the API | ||
service?]{.font-semibold} | ||
4. [How do I authorize the BC Registries API key in order to use it?]{.font-semibold} | ||
|
||
Currently, if you are using BCeID to verify your identity, only one administrator can be on an | ||
account. In this case, you will need an additional account and use your BC Services Card | ||
app to log in. When you use the BC Services Card app to log in, you can have as many | ||
accounts or administrators as you need. | ||
Note: At the end of December 2021, application updates will be made to allow accounts to | ||
have additional administrators. | ||
You can authorize the API key that BC Registries provided to you by using your ServiceBC Connect account number that the API key was issued for. Click on Authorize on the specific registry (eg. Registry Search API or Personal Property Registry APIs). | ||
|
||
[]{.my-4} | ||
|
||
5. [What if I don’t have a BC Services Card app and I can only log in using a BCeID? How | ||
can I have two accounts?]{.font-semibold} | ||
5. [I need to test my search queries, how do I do that?]{.font-semibold} | ||
|
||
You will need to wait for the application changes to be made at the end of December 2021. In | ||
the interim, you will need to pay using PAD or use a BASIC account and pay for | ||
transactions/services (not using the API) with a credit card or online banking. | ||
First, ensure you have a Sandbox API key for your specific account. For Registry Search API, you will need to populate the sandbox environment by making a Business Registry submission of test business data through the Business Registry API first. Then, you can use your search API query to pull the test data created. | ||
|
||
[]{.my-4} | ||
|
||
6. [Can I reuse the identity affidavit that I already provided for my existing Premium | ||
account?]{.font-semibold} | ||
|
||
Yes, but note, only one administrator can be on the account, so if you are using BCeID, you | ||
will need to use the BC Services Card app to verify your identity on the second account. | ||
|
||
[]{.my-4} | ||
|
||
7. [If I’m setting up my account to use APIs, there is a three day waiting period to use | ||
PAD, which freezes my account. What options do I have?]{.font-semibold} | ||
|
||
You can use your BCOL account, credit card or online banking to pay for services while you | ||
wait for the 3 day waiting period to be over. | ||
|
||
If you require support or have questions, please email **[email protected]**. |