CreateOAuthToken

POST - /oauth/request-tokens

Description

Validates a given API Key and issues an access token and refresh token pair when successful.

Headers

Header Key	Description	Example
Csc-Api-Key	The API Key for this message. This is used as primary authentication with the server.	571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiF...

Successful Response

A successful response

Field Name	Type	Description
accessToken	string
refreshToken	string
expiresIn	int32

Code Example

JavaScript (Fetch)

function postV2OauthRequestTokens() {

  const url = 'https://rest.eus.canaryspeech.com/v2/oauth/request-tokens';
  
  const headers = { 'Csc-Api-Key': '571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1' };
  
  fetch(url, {
    method: 'POST',
    headers: headers
  }).then((response) => {
    if (!response.ok) throw new Error(response.status);
    return response.json()
  }).then((json) => {
    const { accessToken, refreshToken, expiresIn } = json;
    // ...
  });
}

JavaScript (Node)

const https = require('https');

function postV2OauthRequestTokens() {

  
  const headers = { 'Csc-Api-Key': '571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1' };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: '/v2/oauth/request-tokens',
    method: 'POST',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { accessToken, refreshToken, expiresIn } = JSON.parse(d);
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.end();
  
}

JavaScript (Axios)

const axios = require('axios').default;

async function postV2OauthRequestTokens() {

  const url = 'https://rest.eus.canaryspeech.com/v2/oauth/request-tokens';
  
  const headers = { 'Csc-Api-Key': '571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1' };
  
  const response = await axios.post(url, null, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { accessToken, refreshToken, expiresIn } = response.data;
  
  // ...
}

TypeScript (Node)

import * as https from 'https';

function postV2OauthRequestTokens(): void {

  
  const headers = { 'Csc-Api-Key': '571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1' };
  
  const options = {
    hostname: 'rest.eus.canaryspeech.com',
    port: 443,
    path: '/v2/oauth/request-tokens',
    method: 'POST',
    headers: headers
  };
  
  const request = https.request(options, (response) => {
    if (response.statusCode !== 200) throw new Error(response.statusCode);
    
    response.on('data', (d) => {
      const { accessToken, refreshToken, expiresIn } = JSON.parse(d) as Record<string, unknown>;
      // ...
    });
  });
  
  request.on('error', (err) => {
    throw new Error(err);
  });
  
  request.end();
}

TypeScript (Axios)

import axios from 'axios';

async function postV2OauthRequestTokens(): Promise<void> {

  const url = 'https://rest.eus.canaryspeech.com/v2/oauth/request-tokens';
  
  const headers = { 'Csc-Api-Key': '571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1' };
  
  const response = await axios.post(url, null, { headers });
  
  if (response.status !== 200) throw new Error(response.status);
  
  const { accessToken, refreshToken, expiresIn } = response.data;
  // ...
}

Python (Requests)

import requests

def post_v2_oauth_request_tokens():
    url = 'https://rest.eus.canaryspeech.com/v2/oauth/request-tokens'
    
    headers = {
        'Csc-Api-Key': '571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1'
    }
    
    response = requests.post(
        url,
        headers=headers,
    )
    
    if response.status_code !== 200:
        raise Exception(response.status_code)
    
    response_obj = response.json()
    access_token = response_obj['accessToken']
    refresh_token = response_obj['refreshToken']
    expires_in = response_obj['expiresIn']
    
    # ...

Java

import org.json.simple.JSONObject;
import org.json.simple.JSONArray;
import org.json.simple.JSONParser;
import org.json.simple.JSONValue;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Map;

public class CanarySpeechApi {

  public void postV2OauthRequestTokens() {
    URI uri = new URI("https://rest.eus.canaryspeech.com/v2/oauth/request-tokens");
    
    HttpRequest request = HttpRequest.newBuilder()
      .uri(uri)
      .version(HttpClient.Version.HTTP_2)
      .header("Csc-Api-Key", "571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1")
      .POST()
      .build();
    
    HttpClient client = HttpClient.newBuilder()
      .version(HttpClient.Version.HTTP_1_1)
      .build();
    
    HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
    
    if (client.status != 200) {
      throw new Exception(client.status.toString());
    }
    
    JSONParser parser = new JSONParser();
    JSONObject responseBody = (JSONObject) parser.parse(client.body());
    String accessToken = (String) responseBody.get("accessToken");
    String refreshToken = (String) responseBody.get("refreshToken");
    Integer expiresIn = (Integer) responseBody.get("expiresIn");
    
    // ...
  }

}

Kotlin

import org.json.JSONObject
import java.lang.StringBuilder
import java.net.URL
import javax.net.ssl.HttpsURLConnection

suspend fun postV2OauthRequestTokens() = runCatching {
    val url = URL.create("https://rest.eus.canaryspeech.com/v2/oauth/request-tokens")
    with(url.openConnection() as HttpsURLConnection) {
        requestMethod = "POST"
        instanceFollowRedirects = true
        
        setRequestProperty("Csc-Api-Key", "571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1")
        
        doOutput = true
        
        if (responseCode != 200) throw Error(responseMessage)
        
        val buffer = StringBuilder()
        var line: String?
        inputStream.bufferedReader(Charsets.UTF-8).use {
            do {
                line = it.readLine()
                if (line != null) buffer.appendLine(line)
            } while (line != null)
        }
        
        val responseBody = JSONObject(buffer.toString())
        val accessToken = responseBody.get("accessToken") as String
        val refreshToken = responseBody.get("refreshToken") as String
        val expiresIn = responseBody.get("expiresIn") as Int
        
        // ...
    }
}

Swift (URLSession)

import UIKit

func postV2OauthRequestTokens() -> void {
    
    let url = URL("https://rest.eus.canaryspeech.com/v2/oauth/request-tokens")
    
    let headers: [String: String] = [ "Csc-Api-Key": "571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1" ]
    
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.allHTTPHeaderFields = headers
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        guard
            let data = data,
            let response = response as? HTTPURLResponse,
            error == nil
        else {
            print("error", error ?? URLError(.badServerResponse)
            return
        }
        
        guard (200 ... 299) ~= response.statusCode else {
            print("statusCode = \(response.statusCode)")
            print("response = \(response)")
            return
        }
        
        do {
            let responseObj = try JSONDecoder().decode(PostV2OauthRequestTokensResponse.self, data)
            // ...
        } catch {
            print(error)
        }
    }
    }
}

struct PostV2OauthRequestTokensResponse: Decodable {
    let accessToken: String
    let refreshToken: String
    let expiresIn: Int32
}

using System.Collections.Generic;
using System.Net.Http;
using System.Text.Encoding;
using System.Text.Json;
using System.Text.Json.Serialization;

public static class CanarySpeechAPI
{
    public static readonly HttpClient client = new HttpClient();
    
    public static async Task postV2OauthRequestTokens()
    {
        var url = "https://rest.eus.canaryspeech.com/v2/oauth/request-tokens\"";
        
        var request = new HttpRequestMessage(HttpMethod.Post, url);
        request.Headers.Add("Csc-Api-Key", "571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1");
        
        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();
        
        var responseBody = await response.Content.ReadAsStringAsync();
        var responseJson = JsonConvert.DeserializeObject<Dictionary<string, dynamic>>(responseBody);
        var accessToken = (String)responseJson["accessToken"];
        var refreshToken = (String)responseJson["refreshToken"];
        var expiresIn = (int)responseJson["expiresIn"];
        // ...
    }
}

Dart/Flutter

import 'dart:convert';

import 'package:http/http.dart' as http;

Future<void> function postV2OauthRequestTokens() async {
  final uri = Uri.https('rest.eus.canaryspeech.com', 'v2/oauth/request-tokens', queryParams);
  
  final headers = { 'Csc-Api-Key': '571CCF:SvJtIepDIolHFZMby7OuGPd9kYwJaWJ18Bp5/Q+6yiFn0FR1' };
  
  final request = http.Request('POST', uri);
  request.headers.addAll(headers)
  
  final client = http.Client();
  try {
    final responseStream = await client.send(request);
    final statusCode = responseStream.statusCode;
    
    if (statusCode < 200 || statusCode >= 300) {
      throw Error(statusCode.toString());
    }
    
    final responseBytes = await responseStream.stream.toBytes();
    final responseString = utf8.decode(responseBytes);
    final response = json.decode(responseString);
    
    final accessToken = response['accessToken'] as String;
    final refreshToken = response['refreshToken'] as String;
    final expiresIn = response['expiresIn'] as int;
    
    // ...
  } catch (e) {
    print(e);
  }
}