Authentication

You need authentication token to access Streams data and resources through the API

Generate authentication token

Best Practices for Auth Token Management

• Reuse Existing Tokens: Before generating a new token, check if you have an existing, valid token that can be reused.
• Minimize New Token Generation: Creating an excessive number of tokens adds unnecessary overhead and can negatively impact the performance of authentication services.
• Generate Only When Necessary: Create a new token only when an existing one has expired or is invalid.

Following these practices ensures optimal system performance and reliability for all services.

---

info

A maximum of 20 authentication tokens can be created per organization.

Make Post request to the below link with the credentials to generate an authentication token.

POST https://app.tpstreams.com/api/auth/login/

Name	Type	Description
username	string	Email address of the user
password	string	Password of the user
organization_id	string	Organization id

Sample code

Python

import requests

url = "https://app.tpstreams.com/api/auth/login/"

payload = "{\n    \"username\": \"hari@example.com\",\n    \"password\": \"welcome\",\n \"organization_id\": \"auhf2k\"}"
headers = {
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Ruby

re 'uri'
require 'net/http'

url = URI("https://app.tpstreams.com/api/auth/login/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request["cache-control"] = 'no-cache'
request.body = "{\n    \"username\": \"hari@example.com\",\n    \"password\": \"welcome\",\n \"organization_id\": \"auhf2k\"}"

response = http.request(request)
puts response.read_body

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://app.tpstreams.com/api/auth/login/',
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "username": "<type_your_emailaddress_here>",
    "password": "<type_your_password_here>",
    "organization_id": "<type_your_organization_id_here>"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response

The response will return an token which should be prefixed with Token and included in all API requests to the server in a header that looks like the following:

Authorization: Token auth-token-string