Skip to main content

API Basics

Here, you'll find essential information about Mindsite API. Understanding these fundamentals will set you up for success as you delve deeper into our API's capabilities. In this section, we'll cover some fundamental concepts and conventions related to the Mindsite API.

HTTPS Security​

Mindsite API is designed with security in mind, and all communication is secured using HTTPS (Hypertext Transfer Protocol Secure). This ensures that data exchanged between your application and our API is encrypted and protected from unauthorized access.

We strongly recommend that you always use HTTPS when making API requests to maintain the confidentiality and integrity of your data.

RESTful API Design​

Mindsite API follows the principles of a RESTful API design, which emphasizes simplicity, scalability, and consistent structure. REST (Representational State Transfer) is an architectural style that leverages standard HTTP methods and status codes to interact with resources.

Our API endpoints are structured to represent resources in a clear and intuitive manner. Each resource is identified by a unique URL, and different HTTP methods are used to perform various actions on these resources.

JSON Request and Response Bodies​

Mindsite API uses JSON (JavaScript Object Notation) for both request and response bodies. JSON is a lightweight data interchange format that is easy for both humans and machines to read and write.

When sending data to the API (e.g., creating or updating resources), use JSON-formatted request bodies. Similarly, when receiving data from the API (e.g., retrieving resources or receiving responses), the data will be returned in JSON format.

Naming Conventions​

Consistent naming conventions enhance the readability and maintainability of your code. Mindsite API follows these naming conventions:

  • Property Names: Property names within JSON objects use snake_case (all lowercase with underscores). For example, "retailer_code", "product_id".
  • Endpoint Names: Endpoint names are in lowercase and use hyphens for word separation. For example, /price, /e-retail-media.
  • HTTP Methods: Use standard HTTP methods in uppercase, such as GET, POST, PUT, and DELETE, to perform actions on resources.