This "How to" guide was made possible thanks to the Michael and Susan Dell Foundation.
Description
The following instructions will guide "How to" guide will walk you through the instantiation of the Google Cloud Ed-Fi ODS/API v3.4 VM and tools. This VM includes the following Ed-Fi assets and environments:
Assets:
- ODS \ API v3.4.0
- Swagger documentation for the API
- Admin application to manage both the Production and Sandbox APIs
Environments:
- Production (Shared Instance)
- Sandbox
Prerequisites
This will be a hands-on activity using the Ed-Fi ODS/API deployed in a VM on Google Cloud, and you will need to provide your own laptop and have access to a Google Cloud tenancy.
...
- 1: Setup a Google Cloud account. Click here: (https://console.cloud.google.com/compute/instances)
2: Request access to the VM image. Please provide your email so that we can share the VM image with you. (send email to douglas.loyo@msdf.org with subject: Google Cloud VM Access)
Setup Instructions
1) Login to (https://console.cloud.google.com/compute/instances)
...
8) At this point you should be in the VM and we can start exploring the Ed-Fi ODS API
Exploring the Ed-Fi ODS API
...
Assets
Exploring Databases
1) Open SSMS (Sql Server Management Studio) by clicking on the icon on the task bar.
...
3) Expand the databases on the left panel (Object Explorer). You will see a list of all databases. At this point you can expand and explore all tables and objects in the Ed-Fi ODS databases.
Exploring IIS and the Available Sites
1) Open IIS (Internet Information Services) by hitting the windows key, typing IIS and hitting enter.
...
- Sandbox API: https://localhost/v3.4.0Sandbox/Api
- Sandbox Swagger: https://localhost/v3.4.0Sandbox/Docs
- client_id: A0hcXwnYrwaj
- client_secret: fIM7AKJNYqDRF2DPgD8zup8i
- Sandbox Admin: https://localhost/v3.4.0Sandbox/SandboxAdmin
- user: test@ed-fi.org
- pass: ***REMOVED***
Exploring the Ed-Fi ODS API through PostMan
1) Open Postman. Click on the icon on the task bar.
...
2) Execute a authorization request: On the left panel expand the folder folders EdFi v3.1.1 → V 3.x and select the "POST Get Auth Token1)GetOAuthToken" request (#1). You can choose what environment you want to use by using the environment dropdown that has been pre-configured with both a sandbox and a production environment. (#2). Once you have selected an environment proceed to click on the "Send" button (#3). Once the request finishes you should see in the results panel a response that contains the access_token.
3) Execute the students request: On the left pane select the "GET Get Students" (#1) request and click the send button (#2). The results panel should show an array of students. (#3)
Note: you have to have authenticated first by running the "POST Get Auth Token" request and getting an access_token as described above.
KNOW Issues:
1) When executing "gcloud compute instance create" it gives the following errors:
...