",
"isAPI": true
}
```
{% endcode %}
{% endhint %}
{% hint style="success" %}
**Success Response**
Get your APIs **access\_token** from `success.data.access_token`
{% code lineNumbers="true" fullWidth="true" %}
```json
{
"success": {
"message":"Authenticated",
"data": {
"success":true,
"expiresAt":1783077877510,
"user": { "username":"email@test.com","scopes":["tme_user"],"isAPI":true },
"ticket":"b1d4b9a9511dd58fb84a9aab9cc2a740",
"access_token":"eyJhbGciO...p_Nlg" // Your APIs Access Token
},
"uuid":"f8623092-a59a-4ceb-bc75-18e59815d5df" // request tag system reference
}
}
```
{% endcode %}
{% endhint %}
{% hint style="warning" %}
**Error Response**
{% code lineNumbers="true" fullWidth="true" %}
```json
{
"error": {
"message":"invalid credentials",
"data":{"invalid":true},
"tag":"6181882e-a5a3-4f28-abce-4f24f4905412" // error tag system reference
},
"uuid":"973e8576-b518-419b-84c3-dd0a7467e64d" // request tag system reference
}
```
{% endcode %}
{% endhint %}
***
{% tabs %}
{% tab title="CURL Example" %}
curl 'https://apis.xpay.stream/client/authenticate' \
-H 'Content-Type: application/json' \
--data-raw '{"username":"<your_email>","secretKey":"<your_key>", "isAPI": "true" }'
{% endtab %}
{% tab title="NodeJS Example" %}
{% code lineNumbers="true" %}
```javascript
// npm i cross-fetch
const fetch = require("cross-fetch");
const API_URL = "https://apis.xpay.stream/client/authenticate";
const method = "POST";
const headers = { "content-type": "application/json" };
const body = JSON.stringify({
username: "your_email",
secretKey: "your_secret",
isAPI: true
});
fetch(API_URL, { headers, body, method })
.then(async res => await res.json())
.then(result => {
if(result.error) {
console.log("Authentication Error", result);
}
if(result.success) {
// use next on access_token
// to authentication all API Calls
// with Header: Authorization Bearer access_token
const access_token = result.success.data.access_token;
console.log("Authentication Success", result);
}
})
.catch((err) => {
console.error(err);
});
// Example Response
const response = {
"success": {
"message": "Authenticated",
"data": {
"success": true,
"expiresAt": 1728210519128,
"user": {
"username": "admin",
"scopes": [
"tme_admin"
],
"isAPI": false
},
"ticket": "4a5753991ab08f5ac8a4732c286bc7dc",
"access_token": "eyJhbGciOiJIUz...XXnxw"
}
},
"uuid": "38e27ab0-d331-4c63-8f24-e1603739511d"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.xpay.stream/authentication-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.