wikitree-api/examples/authentication/javascript.html at main · wikitree/wikitree-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<html>
<head><title>WikiTree API | Authentication</title></head>
<body>

<!-- Use a GitHub Markdown style -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/4.0.0/github-markdown.min.css" integrity="sha512-Oy18vBnbSJkXTndr2n6lDMO5NN31UljR8e/ICzVPrGpSud4Gkckb8yUpqhKuUNoE+o9gAb4O/rAxxw1ojyUVzg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="../examples.css" />

<!-- We'll use jQuery to make the Ajax calls easier. -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>

<!-- Make cookies smoother -->
<script src="../jquery.cookie.js"></script>

<!-- Use a JSON formatter to show the raw result -->
<script src="../json-formatter.js"></script>


<article id="clientLogin" class="markdown-body clientlogin-step">
	<h1>1. clientLogin</h1>
	<p>
		The first step is for you to send the user to https://api.wikitree.com
		where they can login with their WikiTree email and password.
		That form will send you back here with an authorization code. For them
		to land back here, we need to set a <b>returnURL</b> parameter.

		<xmp>
			<form action="https://api.wikitree.com/api.php" method="POST">
				<input type="hidden" name="action" value="clientLogin">
				<input type="hidden" class="returnURL" name="returnURL" value="&lt;&lt;this URL&gt;&gt;">
				<input type="submit" value="Click to Login at WikiTree">
			</form>
		</xmp>

		<form action="https://api.wikitree.com/api.php" method="POST">
			<input type="hidden" name="action" value="clientLogin">
			<input type="hidden" class="returnURL" name="returnURL" value="">
			<input type="submit" value="Click to Login at WikiTree">
		</form>
	</p>
</article>

<article id="confirmWithAuthcode" class="markdown-body clientlogin-step">
	<h1>2. Confirm clientLogin with authcode</h1>
	<p>
		When the API redirects back here (i.e. to <b>returnURL</b>), it appends the
		parameter <b>authcode</b>. See the current page's URL above in the location
		bar of your browser. The value of this parameter is a unique token.
		Step two of the client-login process is to POST that token back to the API
		for confirmation. Upon success, the user is logged in, their browser gets
		cookies on api.wikitree.com with their session, and a result JSON object
		is returned with the user ID and WikiTree ID for the now logged-in user.
	</p>
	<p>
		From the Query String, we found an authcode = <span id="authcodeValue">&lt;&lt;authcode&gt;&gt;</span>.
	</p>
	<p>
		So next we POST that back to the API, again with action = clientLogin, for confirmation.
		<pre>
$.ajax({
	// The WikiTree API endpoint
	'url': API_URL,

	// We tell the browser to send any cookie credentials we might have (in case we authenticated).
	'xhrFields': { withCredentials: true },

	// Doesn't help. Not required from (dev|apps).wikitree.com and api.wikitree.com disallows cross-origin:*
	//'crossDomain': true,

	// We're POSTing the data so we don't worry about URL size limits and want JSON back.
	type: 'POST',
	dataType: 'json',
	data: { 'action':'clientLogin', 'authcode':authcode }
}).done(function(data) {
	if (data.clientLogin.result == 'Success') {
		// Copy the userName (WikiTree iD) and userId returned by the API
		// in our local cookies so we know in the future whether or not the
		// user is signed in.
		userName = data.clientLogin.username;
		userId = data.clientLogin.userid;
		$.cookie('userName', userName);
		$.cookie('userId', userId);

		// Show the user the JSON result of our post.
		$('#authcodeResult').html(FormatJSON(data));
		$('#confirmed').show();
	} else {
		alert("Login failure");
	}
});
		</pre>
		<b>API POST Result:</b>
		<div id="confirmationResult"></div>
	</p>
	<blockquote id="authcodeResult"></blockquote>
	<div id="confirmed" style="display:none">
		Now clean up by redirecting back to ourselves without the authcode in the URL.
		This isn't strictly necessary, but is a good clean-up step. Normally we'd just do this redirection,
		but for this example we'll wait until you click this button.
		<br>
		<button id="selfRedirect">Continue</button>
	</div>

</article>

<article id="authenticated" class="markdown-body clientlogin-step">
	<h1>3. Authenticated! </h1>

	<p>
		The user is (already) authenticated and logged into the API. We've stored their
		user_id (<span id="user_id">&lt;&lt;user_id&gt;&gt;</span>)
		and WikiTree ID (<span id="user_name">&lt;&lt;user_name&gt;&gt;</span>)
		here (with cookies on the local hostname) so we know
		if they depart and return that they're logged in. We don't need to send any
		further authentication/identity information to the API. We just need to
		tell the browser to send along the cookie information for the API hostname so
		that the user's session information goes through and the API action is processed
		for the user signed in.
	</p>
	<p>
		You can test this by using an API function like
		<a href="../getProfile/javascript.html">getProfile</a>
		where you can now retrieve data for private profiles that are on your own watched list.
	</p>
	<p>
		We can also check on our login, e.g. when the page loads, to make sure the userId we stored
		is (still) logged in over at the WikiTree API:
		<blockquote id="checkLoginResult"></blockquote>
	</p>
	<p>
		If you want to see the checkLogin verification fail, you can logout of the API. You'll return here where
		the locally stored Name/Id are still set. But checkLogin will fail so we know you aren't actually logged in at the API.
		<form action="https://api.wikitree.com/api.php" method="POST">
			<input type="hidden" name="action" value="clientLogin">
			<input type="hidden" name="doLogout" value="1">
			<input type="hidden" class="returnURL" name="returnURL" value="">
			<input type="submit" value="Log Out of the API">
		</form>
	</p>
		To clear the locally stored Name/Id, click "Start Over".
		<button id="startOver">Start Over</button>
	</p>
</article>


<script>
// When our page loads, check to see if we are logged in (according to our locally-stored cookie).
// If not, tell the user to go login.
var API_URL = "https://api.wikitree.com/api.php";

$(document).ready(function() {

	// Generalize our returnURL value to be wherever this example is installed.
	// Normally this is just set in the form directly with a "self" URL.
	$('.returnURL').val( window.location.href );

	// Grab data from the cookies and the URL query string so we can assess our state.
	var userName = $.cookie('userName');
	var userId = $.cookie('userId');

	var u = new URLSearchParams(window.location.search)
	var authcode = u.get('authcode');

	$('.clientlogin-step').addClass('inactive');

	// If the user is already logged in, we're done.
	if ((typeof(userName) != 'undefined') && (userName != '')) {
		$('#user_name').html(userName);
		$('#user_id').html(userId);
		$('#authenticated').show().removeClass('inactive');
		document.getElementById('authenticated').scrollIntoView();

		$('#checkLoginResult').html("Checking on login status for user ID:",userId);
		$.ajax({
			'url': API_URL,
			'xhrFields': { withCredentials: true },
			type: 'POST',
			dataType: 'json',
			data: { 'action':'clientLogin', 'checkLogin':userId }
		}).done(function(data) {
			$('#checkLoginResult').html("<pre>"+FormatJSON(data)+"</pre>");
		});

	}

	// If we're not logged in, but the API has just returned us here with an authcode,
	// handle sending that back for confirmation and then saving our user information.
	else if ((typeof authcode != 'undefined') && (authcode != null) && (authcode != '')) {
		$('#confirmWithAuthcode').show().removeClass('inactive');
		document.getElementById('confirmWithAuthcode').scrollIntoView();

		$.ajax({
			// The WikiTree API endpoint
			'url': API_URL,

			// We tell the browser to send any cookie credentials we might have (in case we authenticated).
			'xhrFields': { withCredentials: true },

			// Doesn't help. Not required from (dev|apps).wikitree.com and api.wikitree.com disallows cross-origin:*
			//'crossDomain': true,

			// We're POSTing the data so we don't worry about URL size limits and want JSON back.
			type: 'POST',
			dataType: 'json',
			data: { 'action':'clientLogin', 'authcode':authcode }
		}).done(function(data) {
			$('#authcodeValue').html(authcode);

			if (data.clientLogin.result == 'Success') {
				// Copy the userName (WikiTree iD) and userId returned by the API
				// in our local cookies so we know in the future whether or not the
				// user is signed in.
				userName = data.clientLogin.username;
				userId = data.clientLogin.userid;

				$.cookie('userName', userName);
				$.cookie('userId', userId);

				$('#userName').html(userName);
				$('#userId').html(userId);

				// Show the user the JSON result of our post.
				$('#authcodeResult').html("<pre>"+FormatJSON(data)+"</pre>");
				$('#confirmed').show();
			} else {
				alert("Login failure");
			}
		});

	}

	// If we don't have either an existing login or an authcode to confirm, we need
	// to start off by sending the user to the clientLogin action at the API so they can login.
	else {
		$('#clientLogin').show().removeClass('inactive');
		document.getElementById('clientLogin').scrollIntoView();
	}

	// Set up click handler on our final clean-up/self-redirect button.
	$('#selfRedirect').on('click', function(e) {
		var urlPieces = [location.protocol, '//', location.host, location.pathname]
		var url = urlPieces.join('');
		window.location = url;
	});

	// Set up click handler on start-over button to clear local cookies.
	$('#startOver').on('click', function(e) {
		$.cookie('userName', '');
		$.cookie('userId', '');
		var urlPieces = [location.protocol, '//', location.host, location.pathname]
		var url = urlPieces.join('');
		window.location = url;
	});

});

</script>
</body>
</html>