Getting your aWhere Key and Secret
aWhere Training Tutorial
In order to access aWhere’s historical and forecast data, you need to register for our API (application programming interface) and obtain your key and secret. Your key and secret are essentially your unique passcodes to access the API and are connected to your subscription type. This tutorial will review:
- how to create an account on adaptER Platform,
- create an App to get your key and secret, and
- how to create a credentials file which can then be used in R to access our historical data via our API.
Create your credentials file:
- Go to aWhere’s adaptER Platform and create an account. Note: If you already have an adaptER account, please skip to Step 4.
- Click Get Started and register for an account.
Complete the registration form and you will receive an email to verify your account.
3. You will receive an email from aWhere containing a link to sign in and set your password.
4. Once you’ve signed in, click “start my free access” which will create your key and secret and activate your access to aWhere’s data.
The app In-time Weather API will also take you to the API page where you can access your key and secret and start your Freemium access to API.
5. Once your account is active, you will see your key and secret under the My Account page. By default this app will be a Freemium Subscription with 400 API calls. If you need more API calls, contact us or sign up for a subscription on aWhere.com. If you have a subscription, your key and secret will show up under “aWhere Full API subscriptions”
6. Click on the app to learn more about your Quota and how many API calls you have made. You can also track your API Calls through the Metrics tab.
7. If you plan to use aWhere’s R Scripts, you will need the key and secret to authenticate yourself and access data from the aWhere API. Create a new file in your favorite text editor (such as TextEdit, Notepad++, or Sublime). Copy and paste your Key into the first line. Copy and paste your Secret into the second line (Note: To view your secret, click the ). Add a blank third line. Your text file should have this format:
8. Save the file as “credentials.txt” and if you are following the proposed folder structure from Tutorial: Organizing your Project Files please save your credentials in your Source subfolder. Now you’re ready to access the aWhere API.
Review the next tutorial in the series on accessing aWhere’s training scripts using GitHub with the Tutorial: Accessing aWhere’s R Scripts.
If you have any questions, please contact firstname.lastname@example.org