Начало работы с API
Введение in API
The Parsewise API opens up endless possibilities for integrating documentation in your existing workflows. This lesson introduces the REST API, authentication methods, and basic concepts you'll need to start создатьing custom integrations.
API Architecture Overview
The Parsewise API follows RESTful principles with JSON responses. Все endpoints are accessible via HTTPS at api.parsewise.ru. The API supports standard HTTP methods (GET, POST, PUT, DELETE) and uses conventional HTTP response codes to indicate success or failure.
Authentication and API Keys
Security is paramount when working with APIs. Parsewise uses API key authentication with optional OAuth2 for user-specific actions. To get started:
- Сгенерировать API keys from your account settings
- Set appropriate scopes for each key
- Включить keys in the Авторization header
- Rotate keys regularly for security
Your Первая API Call
Let's start with a simple search query. Using curl or your favorite HTTP client, you can search documents with a single API call. The response includes document metadata, content snippets, and relevance scores. From here, you can создать more complex integrations that automate your documentation workflows.