You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-7Lines changed: 31 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,22 @@ This repository contains examples of calling Alteryx Cloud APIs in various progr
4
4
5
5
Below are the steps to run and use the examples.
6
6
7
-
## 1. Set up credentials
7
+
## 1. Download this repository
8
+
9
+
Either click the "Code > Download Zip" button.
10
+
11
+

12
+
13
+
Or, use `git clone`.
14
+
15
+
Open the files in the downloaded folder.
16
+
17
+
## 2. Set up credentials
8
18
9
19
### `aac_url.txt`
10
20
21
+
In the downloaded `cloud-api-example-code` folder, open `aac_url.txt`.
22
+
11
23
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".
12
24
13
25
This is one of
@@ -20,6 +32,8 @@ Make sure to save the file.
20
32
21
33
### `client_id.txt`
22
34
35
+
In the downloaded `cloud-api-example-code` folder, open `client_id.txt`.
36
+
23
37
Populate this file with your application ID from Alteryx Analytics Cloud.
24
38
25
39
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. 
@@ -34,6 +48,8 @@ Populate this file with your application ID from Alteryx Analytics Cloud.
34
48
35
49
### `creds.json`
36
50
51
+
In the downloaded `cloud-api-example-code` folder, open `creds.json`.
52
+
37
53
This file will contain authentication credentials.
38
54
39
55
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). 
@@ -50,7 +66,7 @@ This file will contain authentication credentials.
50
66
\
51
67
**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.**
52
68
53
-
## 2. Run a program
69
+
## 3. Run a program
54
70
55
71
Now, you are ready to run an example program. Each program will
56
72
@@ -60,9 +76,11 @@ Now, you are ready to run an example program. Each program will
60
76
61
77
### Running the Python Example
62
78
63
-
*Ensure you have at least Python 3.10 installed on your computer.*
79
+
Open your Terminal or command line.
64
80
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.
66
84
67
85
Run
68
86
@@ -80,9 +98,11 @@ The expected output looks like this:
80
98
81
99
### Running the JavaScript example
82
100
83
-
*Ensure you have at least Node 16 installed on your computer.*
101
+
Open your Terminal or command line.
84
102
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.
86
106
87
107
Run
88
108
@@ -112,7 +132,7 @@ The expected output looks like:
112
132
113
133
### Running the bash example
114
134
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`*
116
136
117
137
Make sure you are `cd`ed into this folder.
118
138
@@ -143,6 +163,10 @@ The expected output looks like:
143
163
144
164
Ensure that your client ID in `client_id.txt` is present and correct. See instructions above.
145
165
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.
0 commit comments