> ## Documentation Index
> Fetch the complete documentation index at: https://docs.g-tateth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman Collection

> Import our Postman collection to test the API quickly

We provide a complete Postman collection with all API endpoints pre-configured for easy testing and development.

## Import Collection

### Option 1: Direct Import

1. Open Postman
2. Click **Import** in the top left
3. Select **Link** tab
4. Paste this URL:
   ```
   https://api.g-tateth.com/postman/collection.json
   ```
5. Click **Continue** and **Import**

### Option 2: Download and Import

1. Download the collection file:
   ```bash theme={null}
   curl -O https://api.g-tateth.com/postman/collection.json
   ```
2. Open Postman
3. Click **Import**
4. Select the downloaded `collection.json` file

## Environment Setup

### Create Environment

1. Click **Environments** in the left sidebar
2. Click **+** to create a new environment
3. Name it "g-tateth API"

### Configure Variables

Add these variables:

| Variable    | Initial Value              | Current Value              |
| ----------- | -------------------------- | -------------------------- |
| `base_url`  | `https://api.g-tateth.com` | `https://api.g-tateth.com` |
| `api_key`   | `your-api-key-here`        | `your-api-key-here`        |
| `tenant_id` | `your-tenant-id`           | `your-tenant-id`           |

### Set Active Environment

1. Select your environment from the dropdown in the top right
2. Make sure it's set as the active environment

## Authentication

The collection uses environment variables for authentication. Set your `api_key` in the environment variables.

All requests automatically include:

```http theme={null}
Authorization: Bearer {{api_key}}
```

## Using the Collection

### Run Individual Requests

1. Navigate to the collection folder
2. Select a request
3. Click **Send**
4. View the response in the bottom panel

### Run Collection Tests

1. Click on the collection name
2. Click **Run** button
3. Select requests to run
4. Click **Run g-tateth API**
5. View test results

### Pre-request Scripts

Some requests include pre-request scripts that automatically:

* Set required headers
* Generate timestamps
* Calculate signatures
* Set dynamic values

### Tests

Many requests include automated tests that verify:

* Response status codes
* Response structure
* Data types
* Required fields

## Collection Structure

```
g-tateth API
├── Authentication
│   ├── Login
│   ├── Refresh Token
│   └── Get Profile
├── Conversations
│   ├── List Conversations
│   ├── Get Conversation
│   ├── Create Conversation
│   └── Update Conversation
├── Customers
│   ├── List Customers
│   ├── Get Customer
│   ├── Create Customer
│   └── Update Customer
├── Webhooks
│   ├── List Webhooks
│   ├── Create Webhook
│   └── Delete Webhook
└── Analytics
    ├── Get Usage Stats
    └── Get Analytics
```

## Examples

### Example 1: Create a Conversation

1. Navigate to **Conversations > Create Conversation**
2. Review the request body:
   ```json theme={null}
   {
     "customerId": "{{customer_id}}",
     "channel": "web",
     "subject": "Test Conversation"
   }
   ```
3. Click **Send**
4. Copy the `conversationId` from the response
5. Use it in subsequent requests

### Example 2: Send a Message

1. Navigate to **Conversations > Send Message**
2. Set `conversationId` in the URL path
3. Set message body:
   ```json theme={null}
   {
     "text": "Hello, this is a test message",
     "type": "text"
   }
   ```
4. Click **Send**

## Troubleshooting

### Authentication Errors

If you get 401 errors:

1. Check that `api_key` is set in environment variables
2. Verify the API key is valid
3. Ensure the environment is active

### Variable Not Found

If you see `{{variable}}` in requests:

1. Check that all required variables are set
2. Verify the environment is selected
3. Update variable values if needed

### CORS Errors

If you encounter CORS errors:

1. Use Postman Desktop app (not browser)
2. Or disable CORS in your browser (development only)

## Updates

The collection is updated regularly. To get the latest version:

1. Delete the old collection
2. Re-import from the URL above
3. Or use Postman's **Sync** feature

## Support

Need help with Postman? Contact us:

* **Email**: [support@g-tateth.com](mailto:support@g-tateth.com)
* **Documentation**: [https://docs.g-tateth.com](https://docs.g-tateth.com)