> For the complete documentation index, see [llms.txt](https://aliniex.gitbook.io/alix-pay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://aliniex.gitbook.io/alix-pay/resources/partner-dashboard/overview.md).

# Overview

## Overview

In order to use and test our APIs, you will first need to have an API key to access the endpoints. You can obtain an API key by registering for an account on our AliX Pay [dashboard](https://dashboard.alixpay.com/en/dashboard) via the Sign Up for free! link. Once you have completed the registration process, go to Dashboard and select **Generate API key** button under the API key section on the right of the page. This API key allows you to test our API endpoints in the sandbox environment and get familiarize with the request and responses when using the APIs.

{% hint style="warning" %}
:key: Alix Pay has supported the **2FA** by using <mark style="color:red;">`"Google Authenticator"`</mark> with more security for your account manager.&#x20;

&#x20;**We recommended you will alway enabled it as defaults**
{% endhint %}

### Login with your account provided by Alix Pay during onboarding

{% hint style="info" %}
Google account and SSO login will coming soon!
{% endhint %}

<figure><img src="/files/kkYaJm4Zhwya1S1JOifU" alt=""><figcaption></figcaption></figure>

## Start from integration

{% hint style="info" %}
Please [here](/alix-pay/resources/partner-dashboard/integration.md) for information&#x20;
{% endhint %}

## Supports&#x20;

* AliX Pay support creating the partner account and send invitation letter via email
* AliX Pay required the partner sending a Public key for signature&#x20;
* AliX Pay provided the API end points for partner's integration
* AliX Pay supports SDKs for integration:&#x20;
  * Web SDK (typescript)
  * &#x20;Mobile SDK (react native)
  * Backend SDK(nodejs)
* AliX Pay support a back-office allow partner can do configuration:
  * Webhook: Where the partner can do configuration for IPN\_URL for their listening events from AliX Pay platform  &#x20;
  * App token: Where the partner can create multi application with secure token  ( hash 256)
  * Widget customisation: Where the partner can do customization for theme, color, font-size, text&#x20;
  * Widget translation: Where the partner can change all text following their business with support Vietnamese and English at the moment
  * Statistics: Where the partner monitor all transaction, active users via report and charts&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://aliniex.gitbook.io/alix-pay/resources/partner-dashboard/overview.md?ask=<question>
```

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.