API Owner Guide
Table of Contents:
DataBC offers an API gateway for use with APIs owned and managed by the Province of BC. Staff with an IDIR account can now manage API endpoints through a web interface. Specifically the web application is called the API Gateway Administration (GWA) app.
In order to use GWA you need to have an IDIR account and an API that uses the API Gateway.
If you wish to begin using the API Gateway, log into the BC Data Catalogue and click on the 'Register API button'. You will then be taken to an API registration form which is further described in the following user guide. Alternatively, please send an email to [email protected] and we can discuss your requirements.
If your API already uses the API Gateway and you wish to begin using GWA simply complete the steps below.
Navigate to GWA at the URL below or through the DataBC homepage.
https://gwa.apps.gov.bc.ca/int/
Logging in will register your account with GWA but not grant access right away. During your first attempt to login you will be denied access. Step 2 will involve DataBC granting access.
Figure 1: IDIR Login
Send an email to [email protected] with the subject line 'API owner registration'. Include the name of your API and a link to its associated metadata record in the body of the email.
DataBC will send you an email when your IDIR account is granted access to the GWA along with control of your API endpoint(s).
On the first page you will see lists the endpoints which you have permissions to manage. If you do not see your API listed email [email protected] to confirm your access. You can return to this list at any time by clicking the 'Endpoints' hyperlink found on the top left of the screen.
You will also see your IDIR user name listed in the top right corner of the screen. Just next to your user name is a log out button.
Figure 2: API endpoints list
By clicking on the name of an endpoint in the 'Name' column of the endpoints page you will be taken to the details page for that API.
Within the details page you can perform several actions including.
-
Changing the name of your endpoint.
-
Defining a rate limit for your API. This will define the maximum allowable requests that can be submitted to your API for a given time period. To define a rate limit click on the unit of time you wish to use and type in a number (integer) or use the up and down arrows to change the value. Available units of time include second, minute, hour, day, month and year.
You can also see the properties listed below.
- The date, time and IDIR account for the creation of the endpoint.
- The host name for your API
- If the generation of 'Developer Keys' is allowed.
- If groups are enabled. Groups provide you with the ability to grant individual account with access your API. If you wish to enable automatic authorization to your API for registered developers, simply disable groups.
If you wish to change the value of these properties email [email protected] and DataBC will make this change.
Figure 3: Endpoint details page
By clicking on the 'Groups' link at the top of the page you will see a list of groups with access to your endpoint.
Figure 4: Groups page
By clicking on a group name you will be see the list of users in the group.
To add a user (i.e. 'github_<account name>') to the group click on the 'Add username' text in the top left corner, type the user name and then click the 'Add User' button. Following this the user name should be listed in the 'User' column.
To remove a user from the group, click the red trash can icon beside their name in the actions column.
If you wish to automatically provide API key holders with access to your API, do not create groups.
Figure 5: Group administration
To log out of GWA click on the log out button in the top right corner beside your IDIR user name