Quick Start
Welcome to Arthix! Let's get you set up and ready to make your first authenticated request in just a few minutes.
1. Register an Account
Before diving into the code, you'll need an active Arthix account.
- Open the main Arthix application in your browser.
- Click Register and provide your basic firm details to create your workspace.
- Log in to access your new dashboard.
2. Generate an API Key
To securely connect your application to Arthix, you'll need to generate a unique API Key.
- From your dashboard, click on Settings in the left sidebar.
- Navigate to the Api Key tab under Settings.
- Click Generate New API Key.
- Copy your new key immediately and store it somewhere safe—for security reasons, it won't be shown again!
Treat your API Key like a password. Never share it or publish it in your code. If you suspect it's been exposed, you can easily revoke and regenerate it from your dashboard.
3. Make Your First Request
Now you're ready to test your connection! Simply include your API Key and Firm ID in the headers of your HTTP request.
bash
curl -X POST https://api.arthix.ai/api/v1/contact/getall \
-H "X-Api-Key: a767f974809aa9980d1ad46af3e26a8" \
-H "X-Firm-Id: YOUR_FIRM_ID" \
-H "Content-Type: application/json" \
-d '{}'Successful Response
JSON
{
"isSuccess": true,
"data": [
{
"id": 1,
"firstName": "John",
"lastName": "Doe",
"phone": "+1234567890"
}
],
"message": "Contacts retrieved successfully",
"error": null,
"errors": []
}