Skip to content

Commit 84826ba

Browse files
committed
Update docs with feedback
1 parent be5c423 commit 84826ba

File tree

2 files changed

+31
-7
lines changed

2 files changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,22 @@ This repository contains examples of calling Alteryx Cloud APIs in various progr
44

55
Below are the steps to run and use the examples.
66

7-
## 1. Set up credentials
7+
## 1. Download this repository
8+
9+
Either click the "Code > Download Zip" button.
10+
11+
![alt text](images/download.png)
12+
13+
Or, use `git clone`.
14+
15+
Open the files in the downloaded folder.
16+
17+
## 2. Set up credentials
818

919
### `aac_url.txt`
1020

21+
In the downloaded `cloud-api-example-code` folder, open `aac_url.txt`.
22+
1123
Ensure this file has the appropriate Alteryx Cloud URL. This is the same url you see in your web browser when using Alteryx Cloud, plus "api".
1224

1325
This is one of
@@ -20,6 +32,8 @@ Make sure to save the file.
2032

2133
### `client_id.txt`
2234

35+
In the downloaded `cloud-api-example-code` folder, open `client_id.txt`.
36+
2337
Populate this file with your application ID from Alteryx Analytics Cloud.
2438

2539
1. Visit <https://us1.alteryxcloud.com/cloud-portal/library/alteryx-io> (or <https://eu1.alteryxcloud.com/cloud-portal/library/alteryx-io> or <https://au1.alteryxcloud.com/cloud-portal/library/alteryx-io> for other regions). Ensure that you're logged in to the workspace in which you wish to use APIs. ![The developer console page](images/devConsole.png)
@@ -34,6 +48,8 @@ Populate this file with your application ID from Alteryx Analytics Cloud.
3448

3549
### `creds.json`
3650

51+
In the downloaded `cloud-api-example-code` folder, open `creds.json`.
52+
3753
This file will contain authentication credentials.
3854

3955
1. Navigate to <https://us1.alteryxcloud.com/cloud-portal/preferences/oauth2-api-tokens> (accessible via Your Avatar > User Preferences > OAuth 2.0 API Tokens) (navigate to eu1 or au1 as appropriate). ![The OAuth 2 Tokens Page](images/oauth2Tokens.png)
@@ -50,7 +66,7 @@ This file will contain authentication credentials.
5066
\
5167
**Note: These credentials are sensitive, and anyone who obtains them can access your Alteryx Cloud account. It's recommended to keep them in a credentials vault rather than in plaintext.**
5268

53-
## 2. Run a program
69+
## 3. Run a program
5470

5571
Now, you are ready to run an example program. Each program will
5672

@@ -60,9 +76,11 @@ Now, you are ready to run an example program. Each program will
6076

6177
### Running the Python Example
6278

63-
*Ensure you have at least Python 3.10 installed on your computer.*
79+
Open your Terminal or command line.
6480

65-
Make sure you are `cd`ed into this folder.
81+
*Ensure you have at least Python 3.10 or later installed on your computer. [Download Python here.](https://www.python.org/downloads/)*
82+
83+
Make sure you are `cd`ed into the `cloud-api-example-code` folder.
6684

6785
Run
6886

@@ -80,9 +98,11 @@ The expected output looks like this:
8098

8199
### Running the JavaScript example
82100

83-
*Ensure you have at least Node 16 installed on your computer.*
101+
Open your Terminal or command line.
84102

85-
Make sure you are `cd`ed into this folder.
103+
*Ensure you have at least Node.js 16 or later installed on your computer. [Download Node.js here.](https://nodejs.org/en/download)*
104+
105+
Make sure you are `cd`ed into the `cloud-api-example-code` folder.
86106

87107
Run
88108

@@ -112,7 +132,7 @@ The expected output looks like:
112132

113133
### Running the bash example
114134

115-
*Ensure you have `jq` installed on your computer.*
135+
*Ensure you have `jq` installed on your computer. The most common way to do this on Mac is to [install Homebrew](https://brew.sh/) and then run `brew install jq`*
116136

117137
Make sure you are `cd`ed into this folder.
118138

@@ -143,6 +163,10 @@ The expected output looks like:
143163

144164
Ensure that your client ID in `client_id.txt` is present and correct. See instructions above.
145165

166+
### `rllib.error.URLError: <urlopen error [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:997)>`
167+
168+
If you've installed Python by downloading it into a folder, find that installation folder (e.g. `/Applications/Python 3.10`). Inside the folder there should be a `Install Certificates.command` file. Run this file by double-clicking it.
169+
146170
## Next Steps
147171

148172
- Use this code to call different APIs.

images/download.png

343 KB
Loading

0 commit comments

Comments
 (0)