add tags to swagger
This commit is contained in:
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: 'Client API'
|
||||
description: 'API endpoints for client applications'
|
||||
---
|
||||
|
||||
# Client API
|
||||
|
||||
The Client API provides endpoints for client applications to interact with Chatwoot, including managing contacts, conversations, and messages.
|
||||
|
||||
<Note>
|
||||
Some of these APIs may not require authentication, while others may use alternative authentication methods.
|
||||
</Note>
|
||||
|
||||
## Available Endpoints
|
||||
|
||||
The Client API includes endpoints for:
|
||||
|
||||
- **Contacts API** - APIs for managing contacts from client applications
|
||||
- **Conversations API** - APIs for managing conversations from client applications
|
||||
- **Messages API** - APIs for managing messages from client applications
|
||||
|
||||
## Authentication
|
||||
|
||||
Authentication requirements vary by endpoint. Refer to the specific endpoint documentation for details.
|
||||
|
||||
## Rate Limiting
|
||||
|
||||
Client API requests are subject to rate limiting. Implement appropriate retry logic in your applications.
|
||||
|
||||
## OpenAPI Specification
|
||||
|
||||
The complete OpenAPI specification for the Client API is available below:
|
||||
|
||||
<Card title="OpenAPI Specification" icon="file-code" href="/api-reference/client">
|
||||
View the complete OpenAPI specification for the Client API
|
||||
</Card>
|
||||
|
||||
## Code Examples
|
||||
|
||||
```javascript
|
||||
// Example: Creating a contact using the Client API
|
||||
const response = await fetch('https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}/contacts', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({
|
||||
name: 'John Doe',
|
||||
email: 'john@example.com'
|
||||
})
|
||||
});
|
||||
|
||||
const data = await response.json();
|
||||
console.log(data);
|
||||
```
|
||||
Reference in New Issue
Block a user