REST API/Overview

REST API Overview

Understanding the fundamentals of Eureka Open Platform REST API architecture

API Architecture

Eureka Open Platform provides a RESTful HTTP API that follows industry-standard conventions. All endpoints use predictable, resource-oriented URLs, accept JSON-encoded request bodies, return JSON-encoded responses, and use standard HTTP response codes and authentication.

The API is designed for high performance and reliability, with an average response time of 45ms for enterprise customers.

Base URL

All API requests should be made to the following base URL:

https://connect.patsnap.com

Note: All API requests must use HTTPS. HTTP requests will be rejected.

API Versioning

The API version is included in the URL path. The current stable version is v1:

https://connect.patsnap.com/search/patent/query-search-count

We maintain backward compatibility within major versions. Breaking changes will be introduced in new major versions with advance notice.

Request Methods

The API uses standard HTTP methods to perform operations:

GET

Retrieve Resources

Used to fetch data without modifying server state. GET requests are idempotent and cacheable.

POST

Create or Query Resources

Used to create new resources or perform complex queries with request bodies. Most search endpoints use POST to accept detailed query parameters.

PUT

Update Resources

Used to update existing resources. PUT requests replace the entire resource with the provided data.

DELETE

Remove Resources

Used to delete resources. DELETE requests are idempotent.

Content Type

All requests and responses use JSON format. Always include the following headers:

Request Header
Content-Type: application/json
Response Header
Content-Type: application/json; charset=utf-8

Next Steps

Now that you understand the API basics, learn about request formatting, response structures, and error handling in the following guides.