Exsited Python SDK Installation Guide
An overview of the Exsited Python SDK, its requirements, installation process, configuration, and troubleshooting.
Overview
The Exsited Python SDK provides a user-friendly library for integrating Exsited services into your project. This SDK allows for seamless integration with Custom Integration, Onsite Integration, and all Exsited APIs.
Requirements
- Python Version: 3.12 or later
Installation Process
pip install exsited Configuration
Before using the Exsited SDK, you need to configure it with your Client ID, Client Secret, and Redirect URL. If you don’t have these credentials, please reach out to your Exsited account manager or designated client contact.
Step 1: Create a config.py File
In your project directory, create a file named config.py that contains the OAuth 2.0 authentication setup. This file will store your credentials and configuration details.
from exsited.exsited.auth.dto.token_dto import RequestTokenDTO
class CommonData:
@staticmethod
def get_request_token_dto():
return RequestTokenDTO(
grantType="client_credentials",
clientId="YOUR_CLIENT_ID",
clientSecret="YOUR_CLIENT_SECRET",
redirectUri="YOUR_REDIRECT_URI",
exsitedUrl="YOUR_EXSITED_SERVER_URL",
)Step 2: Set Up Credentials
Fill in the placeholder values (client_id, etc.) with the actual credentials provided by Exsited. Here’s what each placeholder represents:
| Key | Description |
|---|---|
| clientId | Your unique Client ID. |
| clientSecret | The Client Secret provided to you for secure authentication. |
| redirectUri | The URL where the authentication response will be sent after a successful login. |
| exsitedUrl | The base URL for the Exsited API server. |
Credentials Table
| Key | Value |
|---|---|
| clientId | "YOUR_CLIENT_ID" |
| clientSecret | "YOUR_CLIENT_SECRET" |
| redirectUrl | "YOUR_REDIRECT_URI" |
| exsitedUrl | "YOUR_EXSITED_SERVER_URL" |
Troubleshooting
- Incorrect Credentials: Ensure that your Client ID, Client Secret, and Redirect URL are correct. If you're having issues with the authentication process, contact Exsited support for assistance.
- API Environment: Make sure you're using the correct API environment (staging or production) in the exsitedUrl parameter.
Support Information
For any questions or issues related to the Exsited Python SDK, contact the Exsited support team at support@exsited.com.