<titledata-react-helmet="true">Token Swap | SpotifyAPI-NET</title><metadata-react-helmet="true"property="og:url"content="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/5.1.1/auth/token_swap"><metadata-react-helmet="true"name="docusaurus_locale"content="en"><metadata-react-helmet="true"name="docusaurus_version"content="5.1.1"><metadata-react-helmet="true"name="docusaurus_tag"content="docs-default-5.1.1"><metadata-react-helmet="true"property="og:title"content="Token Swap | SpotifyAPI-NET"><metadata-react-helmet="true"name="description"content="This way uses server-side code or at least access to an exchange server, otherwise, compared to other"><metadata-react-helmet="true"property="og:description"content="This way uses server-side code or at least access to an exchange server, otherwise, compared to other"><linkdata-react-helmet="true"rel="shortcut icon"href="/SpotifyAPI-NET/img/favicon.ico"><linkdata-react-helmet="true"rel="canonical"href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/5.1.1/auth/token_swap"><linkdata-react-helmet="true"rel="alternate"href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/5.1.1/auth/token_swap"hreflang="en"><linkdata-react-helmet="true"rel="alternate"href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/5.1.1/auth/token_swap"hreflang="x-default"><linkrel="stylesheet"href="/SpotifyAPI-NET/assets/css/styles.834af7f3.css">
methods, it is impossible to use.</p><p>With this approach, you provide the URI/URL to your desired exchange server to perform all necessary
requests to Spotify, as well as requests that return back to the "server URI".</p><p>The exchange server <strong>must</strong> be able to:</p><ul><li>Return the authorization code from Spotify API authenticate page via GET request to the "server URI".</li><li>Request the token response object via POST to the Spotify API token page.</li><li>Request a refreshed token response object via POST to the Spotify API token page.</li></ul><p><strong>The good news is that you do not need to code it yourself.</strong></p><p>The advantages of this method are that the client ID and redirect URI are very well hidden and almost unexposed, but more importantly, your client secret is <strong>never</strong> exposed and is completely hidden compared to other methods (excluding <ahref="/SpotifyAPI-NET/docs/5.1.1/auth/implicit_grant">ImplicitGrantAuth</a>
as it does not deal with a client secret). This means
your Spotify app <strong>cannot</strong> be spoofed by a malicious third party.</p><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_2LWZ"id="using-tokenswapwebapifactory"></a>Using TokenSwapWebAPIFactory<aclass="hash-link"href="#using-tokenswapwebapifactory"title="Direct link to heading">#</a></h2><p>The TokenSwapWebAPIFactory will create and configure a SpotifyWebAPI object for you.</p><p>It does this through the method GetWebApiAsync <strong>asynchronously</strong>, which means it will not halt execution of your program while obtaining it for you. If you would like to halt execution, which is <strong>synchronous</strong>, use <code>GetWebApiAsync().Result</code> without using <strong>await</strong>.</p><divclass="codeBlockContainer_K1bP"><divclass="codeBlockContent_hGly csharp"><pretabindex="0"class="prism-code language-csharp codeBlock_23N8 thin-scrollbar"style="color:#bfc7d5;background-color:#292d3e"><codeclass="codeBlockLines_39YC"><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">TokenSwapWebAPIFactory webApiFactory;</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">SpotifyWebAPI spotify;</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"style="display:inline-block">
</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">// You should store a reference to WebAPIFactory if you are using AutoRefresh or want to manually refresh it later on. New WebAPIFactory objects cannot refresh SpotifyWebAPI object that they did not give to you.</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">webApiFactory = new TokenSwapWebAPIFactory("INSERT LINK TO YOUR index.php HERE")</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">{</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> Scope = Scope.UserReadPrivate | Scope.UserReadEmail | Scope.PlaylistReadPrivate,</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> AutoRefresh = true</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">};</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">// You may want to react to being able to use the Spotify service.</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">// webApiFactory.OnAuthSuccess += (sender, e) => authorized = true;</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">// You may want to react to your user's access expiring.</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">// webApiFactory.OnAccessTokenExpired += (sender, e) => authorized = false;</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"style="display:inline-block">
</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">try</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">{</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> spotify = await webApiFactory.GetWebApiAsync();</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> // Synchronous way:</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> // spotify = webApiFactory.GetWebApiAsync().Result;</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">}</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">catch (Exception ex)</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">{</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> // Example way to handle error reporting gracefully with your SpotifyWebAPI wrapper</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> // UpdateStatus($"Spotify failed to load: {ex.Message}");</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">}</span></span></code></pre><buttontype="button"aria-label="Copy code to clipboard"class="copyButton_Ue-o clean-btn">Copy</button></div></div><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_2LWZ"id="using-tokenswapauth"></a>Using TokenSwapAuth<aclass="hash-link"href="#using-tokenswapauth"title="Direct link to heading">#</a></h2><p>Since the TokenSwapWebAPIFactory not only simplifies the whole process but offers additional functionality too
recommended if you are having issues with TokenSwapWebAPIFactory or need access to the tokens.</p><divclass="codeBlockContainer_K1bP"><divclass="codeBlockContent_hGly csharp"><pretabindex="0"class="prism-code language-csharp codeBlock_23N8 thin-scrollbar"style="color:#bfc7d5;background-color:#292d3e"><codeclass="codeBlockLines_39YC"><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">TokenSwapAuth auth = new TokenSwapAuth(</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> exchangeServerUri: "INSERT LINK TO YOUR index.php HERE",</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> serverUri: "http://localhost:4002",</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> scope: Scope.UserReadPrivate | Scope.UserReadEmail | Scope.PlaylistReadPrivate</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">);</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">auth.AuthReceived += async (sender, response) =></span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">{</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> lastToken = await auth.ExchangeCodeAsync(response.Code);</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"style="display:inline-block">
</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> authenticated = true;</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain"> auth.Stop();</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">};</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">auth.OnAccessTokenExpired += async (sender, e) => spotify.AccessToken = (await auth.RefreshAuthAsync(lastToken.RefreshToken)).AccessToken;</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">auth.Start();</span></span><spanclass="token-line"style="color:#bfc7d5"><spanclass="token plain">auth.OpenBrowser();</span></span></code></pre><buttontype="button"aria-label="Copy code to clipboard"class="copyButton_Ue-o clean-btn">Copy</button></div></div><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_2LWZ"id="token-swap-endpoint"></a>Token Swap Endpoint<aclass="hash-link"href="#token-swap-endpoint"title="Direct link to heading">#</a></h2><p>To keep your client secret completely secure and your client ID and redirect URI as secure as possible, use of a web server (such as a php website) is required.</p><p>To use this method, an external HTTP Server (that you may need to create) needs to be able to supply the following HTTP Endpoints to your application:</p><p><code>/swap</code> - Swaps out an <code>authorization_code</code> with an <code>access_token</code> and <code>refresh_token</code> - The following parameters are required in the JSON POST Body:</p><ul><li><code>grant_type</code> (set to <code>"authorization_code"</code>)</li><li><code>code</code> (the <code>authorization_code</code>)</li><li><code>redirect_uri</code></li><li><ul><li><strong>Important</strong> The page that the redirect URI links to must return the authorization code json to your <code>serverUri</code> (default is 'http://localhost:4002') but to the folder 'auth', like this: 'http://localhost:4002/auth'.</li></ul></li></ul><p><code>/refresh</code> - Refreshes an <code>access_token</code> - The following parameters are required in the JSON POST Body:</p><ul><li><code>grant_type</code> (set to <code>"refresh_token"</code>)</li><li><code>refresh_token</code></li></ul><p>The following open-source token swap endpoint code can be used for your website:</p><ul><li><ahref="https://github.com/rollersteaam/spotify-token-swap-php"target="_blank"rel="noopener noreferrer">rollersteaam/spotify-token-swap-php</a></li><li><ahref="https://github.com/simontaen/SpotifyTokenSwap"target="_blank"rel="noopener noreferrer">simontaen/SpotifyTokenSwap</a></li></ul><h2><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_2LWZ"id="remarks"></a>Remarks<aclass="hash-link"href="#remarks"title="Direct link to heading">#</a></h2><p>It should be noted that GitHub Pages does not support hosting php scripts. Hosting php scripts through it will cause the php to render as plain HTML, potentially compromising your client secret while doing absolutely nothing.</p><p>Be sure you have whitelisted your redirect uri in the Spotify Developer Dashboard otherwise the authorization will always fail.</p><p>If you did not use the WebAPIFactory or you provided a <code>serverUri</code> different from its default, you must make sure your redirect uri's script at your endpoint will properly redirect to your <code>serverUri</code> (such as changing the areas which refer to <code>localhost:4002</code> if you had changed <code>serverUri</code> from its default), otherwise it will never reach your new <code>serverUri</code>.</p></div><footerclass="row docusaurus-mt-lg"><divclass="col"><ahref="https://github.com/JohnnyCrazy/SpotifyAPI-NET/edit/master/SpotifyAPI.Docs/versioned_docs/version-5.1.1/auth/token_swap.md"target="_blank"rel="noreferrer noopener"><svgfill="currentColor"height="20"width="20"viewBox="0 0 40 40"class="iconEdit_2_ui"aria-hidden="true"><g><pathd="m34.511.7l-33
