Poker Framework - @pokerscript
  • Introduction
    • Prerequisites
    • Server
    • Installations
  • Deployment
    • Backend
    • Frontend
  • Connector APIs
    • Plateform API
    • SignUp API
    • LogIn API
    • Profile API
    • Profile Update API
    • Chips Update API
  • Quickstart Guide
    • Primary Setup
    • Logo & Branding
    • Stake Configuration
    • Blind Levels
    • MTT Payouts
    • SnG Payouts
    • Web3 Settings
    • Buy Hours Package
    • Avatar Manager
    • Crypto Payments
    • Table Gifts
    • Tournament Setup (MTT)
Powered by GitBook
On this page
  • Overview
  • Endpoint
  • Headers
  • Request Body
  • Success Response
  • Error Responses
  • Additional Notes

Was this helpful?

  1. Connector APIs

Profile Update API

Allow players to customise their profile data, images and more.

Overview

The Profile Update API allows you to modify player details in Pokerscript, including updating user profile information and chip balance. This API is essential for maintaining player accounts and managing chip transactions within the platform.

Endpoint

POST http://admin.pokerurl.com/api/profile

Headers

Key
Value
Description

AuthKey

489j4erwginerwgirn

Client key provided by Pokerscript

Accept

application/JSON

Specifies response format

Content-Type

application/JSON

Specifies request format

Authorization

Bearer <UserToken>

User authentication token

Request Body

The request body should be formatted in JSON and include the following fields:

{
    "email": "support@pokerscript.net",
    "username": "username",
    "firstname": "first",
    "lastname": "last",
    "chips": 100.00,
}

Parameters

Parameter
Type
Description

email

string

Email address of the player

username

string

Unique username of the player

firstname

string

First name of the player

lastname

string

Last name of the player

chips

float

Updated chip balance of the player

Note

  • UserToken is obtained from the Login API and must be stored securely for future use.

Success Response

Upon a successful profile update, the API returns a 200 OK status with the following response:

{
    "status": true,
    "message": "Profile Updated Successfully",
    "data": {
        "playerId": "607c7db76a40702ba15cfb4a",
        "email": "support@pokerscript.net",
        "username": "username",
        "firstname": "first",
        "lastname": "last",
        "avatar": "doraemon.png",
        "chips": 100.00,
        "hour_balance": "10:00",
        "is_able": true,
        "mobile": +19177649944,
        "isCash": true,
        "language": "en",
        "country": "US",
        "vipLevel": 2
    }
}

Error Responses

If the request fails, an error response is returned with the corresponding status code:

401 Unauthorized

{
    "status": false,
    "message": "Invalid Authorization Token"
}

404 Not Found

{
    "status": false,
    "message": "User Not Found"
}

500 Internal Server Error

{
    "status": false,
    "message": "Something Went Wrong"
}

Additional Notes

  • Ensure that the UserToken is valid and not expired.

  • The AuthKey should be provided by Pokerscript for API access.

  • Always use secure storage for sensitive tokens and authentication keys.

This API enables seamless player management by allowing profile updates and chip transactions while ensuring data security and integrity.

PreviousProfile APINextChips Update API

Last updated 3 months ago

Was this helpful?