diff --git a/.gitmodules b/.gitmodules index ef5b3e63cf..54a177465b 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ [submodule "evolution-manager-v2"] path = evolution-manager-v2 - url = https://github.com/EvolutionAPI/evolution-manager-v2.git + url = https://github.com/evolution-foundation/evolution-manager-v2.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..8aa5df1c7f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,88 @@ +# Contributing to Evolution API + +Thanks for your interest in contributing to Evolution API! This document +outlines how to contribute effectively. + +## Code of Conduct + +All contributors are expected to be respectful, inclusive, and professional. +Harassment, discrimination, or abusive behavior will not be tolerated. + +## How to Contribute + +### Reporting Bugs + +1. Check existing [issues](https://github.com/evolution-foundation/evolution-api/issues) + to avoid duplicates +2. Open a new issue with: + - Clear, descriptive title + - Steps to reproduce + - Expected vs actual behavior + - Environment details (OS, version, dependencies) + - Logs or screenshots when relevant + +### Suggesting Features + +1. Open an issue describing: + - The problem you're trying to solve + - Your proposed solution + - Alternatives you considered +2. Wait for maintainer feedback before starting implementation + +### Submitting Pull Requests + +1. Fork the repository +2. Create a feature branch from `develop`: + ```bash + git checkout -b feat/your-feature-name + ``` +3. Make your changes following the project's coding standards +4. Write or update tests for your changes +5. Ensure all tests pass and the code lints clean +6. Commit using [Conventional Commits](https://www.conventionalcommits.org/): + ``` + feat: add new feature + fix: resolve bug in X + docs: update README + refactor: simplify Y + test: add coverage for Z + ``` +7. Push to your fork and open a PR against `develop` +8. Fill out the PR template with context, testing notes, and screenshots if + applicable + +## Development Setup + +See [README.md](./README.md) for project-specific setup instructions. + +## Code Standards + +- Follow the existing code style of the project +- Run linters and formatters before committing +- Add tests for new features and bug fixes +- Document public APIs and non-obvious behavior +- Keep commits atomic and focused + +## Branch Strategy + +- `main` — stable production-ready code +- `develop` — integration branch for upcoming releases +- `feat/*`, `fix/*`, `chore/*` — short-lived branches off `develop` + +## Trademark Notice + +By contributing, you agree that your contributions will be licensed under the +Apache License 2.0 (see [LICENSE](./LICENSE)). Trademarks and brand assets are +governed separately by [TRADEMARKS.md](./TRADEMARKS.md). + +## Questions? + +- **Community**: [evolutionfoundation.com.br/community](https://evolutionfoundation.com.br/community) +- **Documentation**: [docs.evolutionfoundation.com.br](https://docs.evolutionfoundation.com.br) +- **Email**: suporte@evofoundation.com.br + +Thanks for helping make Evolution API better! + +--- + +© 2026 Evolution Foundation diff --git a/LICENSE b/LICENSE index 18ebe6f6b0..0764bd0b13 100644 --- a/LICENSE +++ b/LICENSE @@ -4,18 +4,205 @@ Evolution API is licensed under the Apache License 2.0, with the following addit 1. Evolution API may be utilized commercially, including as a backend service for other applications or as an application development platform for enterprises. Should the conditions below be met, a commercial license must be obtained from the producer: -a. LOGO and copyright information: In the process of using Evolution API's frontend components, you may not remove or modify the LOGO or copyright information in the Evolution API console or applications. This restriction is inapplicable to uses of Evolution API that do not involve its frontend components. + a. **LOGO and copyright information**: In the process of using Evolution API's frontend components, you may not remove or modify the LOGO or copyright information in the Evolution API console or applications. This restriction is inapplicable to uses of Evolution API that do not involve its frontend components. -b. Usage Notification Requirement: If Evolution API is used as part of any project, including closed-source systems (e.g., proprietary software), the user is required to display a clear notification within the system that Evolution API is being utilized. This notification should be visible to system administrators and accessible from the system's documentation or settings page. Failure to comply with this requirement may result in the necessity for a commercial license, as determined by the producer. + b. **Usage Notification Requirement**: If Evolution API is used as part of any project, including closed-source systems (e.g., proprietary software), the user is required to display a clear notification within the system that Evolution API is being utilized. This notification should be visible to system administrators and accessible from the system's documentation or settings page. Failure to comply with this requirement may result in the necessity for a commercial license, as determined by the producer. -Please contact contato@evolution-api.com to inquire about licensing matters. +Please contact suporte@evofoundation.com.br to inquire about licensing matters. -2. As a contributor, you should agree that: +Apart from the specific conditions mentioned above, all other rights and restrictions follow the Apache License 2.0. Detailed information about the Apache License 2.0 can be found at http://www.apache.org/licenses/LICENSE-2.0. -a. The producer can adjust the open-source agreement to be more strict or relaxed as deemed necessary. -b. Your contributed code may be used for commercial purposes, including but not limited to its cloud business operations. +--- -Apart from the specific conditions mentioned above, all other rights and restrictions follow the Apache License 2.0. Detailed information about the Apache License 2.0 can be found at http://www.apache.org/licenses/LICENSE-2.0. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2026 Evolution Foundation + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 -© 2025 Evolution API + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +© 2026 Evolution Foundation diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000000..b28ebb1439 --- /dev/null +++ b/NOTICE @@ -0,0 +1,19 @@ +Evolution API +Copyright 2026 Evolution Foundation + +This product includes software developed by Evolution Foundation +(https://evolutionfoundation.com.br). + +Trademark notice +"Evolution Foundation", "Evolution" and "Evolution API" are trademarks of +Evolution Foundation. The Evolution API logo, wordmark, and visual identity +are governed by the Trademark and Brand Assets Policy included in this +repository (TRADEMARKS.md). + +Third-party attributions + +This product includes software derived from CodeChat WhatsApp API +(https://github.com/code-chat-br/whatsapp-api), originally licensed under MIT. +The CodeChat project implemented the Baileys library +(https://github.com/WhiskeySockets/Baileys), which Evolution API also uses for +its WhatsApp Web integration. diff --git a/README.md b/README.md index eb7e638c16..4586e4028a 100644 --- a/README.md +++ b/README.md @@ -1,144 +1,224 @@ -
+
+
+
+
+ Open-source REST API for WhatsApp and multi-channel messaging — part of the Evolution Foundation ecosystem. +
-
+ Website · + Documentation · + Community · + Support +
-Evolution API began as a WhatsApp controller API based on [CodeChat](https://github.com/code-chat-br/whatsapp-api), which in turn implemented the [Baileys](https://github.com/WhiskeySockets/Baileys) library. While originally focused on WhatsApp, Evolution API has grown into a comprehensive platform supporting multiple messaging services and integrations. We continue to acknowledge CodeChat for laying the groundwork. +--- -Today, Evolution API is not limited to WhatsApp. It integrates with various platforms such as Typebot, Chatwoot, Dify, and OpenAI, offering a broad array of functionalities beyond messaging. Evolution API supports both the Baileys-based WhatsApp API and the official WhatsApp Business API, with upcoming support for Instagram and Messenger. +## About -## Looking for a Lightweight Version? -For those who need a more streamlined and performance-optimized version, check out [Evolution API Lite](https://github.com/EvolutionAPI/evolution-api-lite). It's designed specifically for microservices, focusing solely on connectivity without integrations or audio conversion features. Ideal for environments that prioritize simplicity and efficiency. +**Evolution API** is a powerful, production-ready REST API for WhatsApp and multi-channel messaging. Originally focused on WhatsApp, it has grown into a comprehensive platform supporting multiple messaging providers and integrations. -## Types of Connections +Today, Evolution API supports both the Baileys-based WhatsApp Web API and the official WhatsApp Cloud API, plus integrations with Typebot, Chatwoot, Dify, OpenAI, RabbitMQ, Apache Kafka, Amazon SQS, Socket.io, Amazon S3 / MinIO, and more. -Evolution API supports multiple types of connections to WhatsApp, enabling flexible and powerful integration options: +Evolution API began as a WhatsApp controller API based on [CodeChat](https://github.com/code-chat-br/whatsapp-api), which in turn implemented the [Baileys](https://github.com/WhiskeySockets/Baileys) library. We continue to acknowledge CodeChat for laying the groundwork. -- *WhatsApp API - Baileys*: - - A free API based on WhatsApp Web, leveraging the [Baileys library](https://github.com/WhiskeySockets/Baileys). - - This connection type allows control over WhatsApp Web functionalities through a RESTful API, suitable for multi-service chats, service bots, and other WhatsApp-integrated systems. - - Note: This method relies on the web version of WhatsApp and may have limitations compared to official APIs. +## Part of the Evolution Foundation ecosystem -- *WhatsApp Cloud API*: - - The official API provided by Meta (formerly Facebook). - - This connection type offers a robust and reliable solution designed for businesses needing higher volumes of messaging and better integration support. - - The Cloud API supports features such as end-to-end encryption, advanced analytics, and more comprehensive customer service tools. - - To use this API, you must comply with Meta's policies and potentially pay for usage based on message volume and other factors. +Evolution API is one of the messaging engines maintained by Evolution Foundation. It is used as a WhatsApp provider by the [Evo CRM Community](https://github.com/evolution-foundation/evo-crm-community) and other projects in the ecosystem. + +--- + +## Connection Types + +Evolution API supports multiple connection types to WhatsApp: + +### WhatsApp API — Baileys +A free API based on WhatsApp Web, leveraging the [Baileys library](https://github.com/WhiskeySockets/Baileys). Suitable for multi-service chats, service bots, and WhatsApp-integrated systems. Note: this method relies on the web version of WhatsApp and may have limitations compared to official APIs. + +### WhatsApp Cloud API +The official API provided by Meta. Designed for businesses with higher messaging volumes and stronger integration support, including end-to-end encryption, advanced analytics, and customer service tools. Requires compliance with Meta's policies and may incur per-message costs. + +--- ## Integrations -Evolution API supports various integrations to enhance its functionality. Below is a list of available integrations and their uses: +Evolution API integrates natively with many platforms: + +- **[Typebot](https://typebot.io/)** — conversational bots with trigger management +- **[Chatwoot](https://www.chatwoot.com/)** — customer service platform +- **[RabbitMQ](https://www.rabbitmq.com/)** — event streaming via AMQP +- **[Apache Kafka](https://kafka.apache.org/)** — real-time event streaming and processing +- **[Amazon SQS](https://aws.amazon.com/sqs/)** — cloud-based message queuing +- **[Socket.io](https://socket.io/)** — real-time WebSocket events +- **[Dify](https://dify.ai/)** — AI agent workflows +- **[OpenAI](https://openai.com/)** — AI capabilities including audio-to-text conversion +- **Amazon S3 / [MinIO](https://min.io/)** — media file storage + +--- + +## Quick Start + +### Prerequisites + +- **Node.js** 20+ +- **PostgreSQL** or **MySQL** +- **Redis** (recommended for caching) + +### Installation + +```bash +git clone git@github.com:evolution-foundation/evolution-api.git +cd evolution-api + +# Install dependencies +npm install + +# Configure environment +cp .env.example .env +# Edit .env with your database, Redis, and API key +``` -- [Typebot](https://typebot.io/): - - Build conversational bots using Typebot, integrated directly into Evolution with trigger management. +### Database setup -- [Chatwoot](https://www.chatwoot.com/): - - Direct integration with Chatwoot for handling customer service for your business. +```bash +# Set the database provider +export DATABASE_PROVIDER=postgresql # or mysql -- [RabbitMQ](https://www.rabbitmq.com/): - - Receive events from the Evolution API via RabbitMQ. +# Generate Prisma client +npm run db:generate -- [Apache Kafka](https://kafka.apache.org/): - - Receive events from the Evolution API via Apache Kafka for real-time event streaming and processing. +# Deploy migrations +npm run db:deploy +``` -- [Amazon SQS](https://aws.amazon.com/pt/sqs/): - - Receive events from the Evolution API via Amazon SQS. +### Running -- [Socket.io](https://socket.io/): - - Receive events from the Evolution API via WebSocket. +```bash +# Development with hot reload +npm run dev:server -- [Dify](https://dify.ai/): - - Integrate your Evolution API directly with Dify AI for seamless trigger management and multiple agents. +# Production build and run +npm run build +npm run start:prod +``` -- [OpenAI](https://openai.com/): - - Integrate your Evolution API with OpenAI for AI capabilities, including audio-to-text conversion, available across all Evolution integrations. +### Docker -- Amazon S3 / Minio: - - Store media files received in [Amazon S3](https://aws.amazon.com/pt/s3/) or [Minio](https://min.io/). +```bash +docker pull evoapicloud/evolution-api:latest +docker run -p 8080:8080 --env-file .env evoapicloud/evolution-api:latest +``` -## Community & Feedback +--- -We value community input and feedback to continuously improve Evolution API: +## Architecture -### 🚀 Feature Requests & Roadmap -- **[Feature Requests](https://evolutionapi.canny.io/feature-requests)**: Submit new feature ideas and vote on community proposals -- **[Roadmap](https://evolutionapi.canny.io/feature-requests)**: View planned features and development progress -- **[Changelog](https://evolutionapi.canny.io/changelog)**: Stay updated with the latest releases and improvements +Evolution API is built with a multi-provider, event-driven architecture: -### 💬 Community Support -- **[WhatsApp Group](https://evolution-api.com/whatsapp)**: Join our community for support and discussions -- **[Discord Community](https://evolution-api.com/discord)**: Real-time chat with developers and users -- **[GitHub Issues](https://github.com/EvolutionAPI/evolution-api/issues)**: Report bugs and technical issues +``` +Client / CRM + ↓ +Evolution API + ├── Channel Integrations (Baileys / Cloud API) + ├── Chatbot Integrations (Typebot, Chatwoot, OpenAI, Dify, Flowise, N8N) + ├── Event Integrations (WebSocket, RabbitMQ, SQS, NATS, Pusher) + └── Storage Integrations (S3, MinIO) +``` -### 🔒 Security -- **[Security Policy](./SECURITY.md)**: Guidelines for reporting security vulnerabilities -- **Security Contact**: contato@evolution-api.com +Built with **Node.js 20+**, **TypeScript 5+**, and **Express.js**, it provides extensive integrations with chatbots, CRM systems, and messaging platforms. -## Telemetry Notice +### Multi-database support +PostgreSQL and MySQL via Prisma ORM with provider-specific schemas and migrations. -To continuously improve our services, we have implemented telemetry that collects data on the routes used, the most accessed routes, and the version of the API in use. We would like to assure you that no sensitive or personal data is collected during this process. The telemetry helps us identify improvements and provide a better experience for users. +### Authentication +- API key-based authentication via `apikey` header +- Instance-specific tokens for WhatsApp connection authentication +- Webhook signature validation for external integrations -## Evolution Support Premium +### Message queue support +RabbitMQ, Amazon SQS, NATS, Pusher and WebSocket for events. Configurable per instance. -Join our Evolution Pro community for expert support and a weekly call to answer questions. Visit the link below to learn more and subscribe: +### Media handling +Local storage or S3/MinIO. Automatic media download from WhatsApp. Optional audio transcription via OpenAI. -[Click here to learn more](https://evolution-api.com/suporte-pro) +--- -# Donate to the project. +## Documentation -#### Github Sponsors +| Resource | Link | +|---|---| +| Website | [evolutionfoundation.com.br](https://evolutionfoundation.com.br) | +| Documentation | [docs.evolutionfoundation.com.br](https://docs.evolutionfoundation.com.br) | +| Community | [evolutionfoundation.com.br/community](https://evolutionfoundation.com.br/community) | +| Docker Hub | [evoapicloud/evolution-api](https://hub.docker.com/r/evoapicloud/evolution-api) | +| Changelog | [CHANGELOG.md](./CHANGELOG.md) | +| Contributing | [CONTRIBUTING.md](./CONTRIBUTING.md) | +| Security | [SECURITY.md](./SECURITY.md) | -https://github.com/sponsors/EvolutionAPI +--- -# Content Creator Partners +## Hosting -We are proud to collaborate with the following content creators who have contributed valuable insights and tutorials about Evolution API: +Deploy Evolution API with optimized infrastructure through our HostGator partnership: -- [Promovaweb](https://www.youtube.com/@promovaweb) -- [Sandeco](https://www.youtube.com/@canalsandeco) -- [Comunidade ZDG](https://www.youtube.com/@ComunidadeZDG) -- [Francis MNO](https://www.youtube.com/@FrancisMNO) -- [Pablo Cabral](https://youtube.com/@pablocabral) -- [XPop Digital](https://www.youtube.com/@xpopdigital) -- [Costar Wagner Dev](https://www.youtube.com/@costarwagnerdev) -- [Dante Testa](https://youtube.com/@dantetesta_) -- [Rubén Salazar](https://youtube.com/channel/UCnYGZIE2riiLqaN9sI6riig) -- [OrionDesign](youtube.com/OrionDesign_Oficial) -- [IMPA 365](youtube.com/@impa365_ofc) -- [Comunidade Hub Connect](https://youtube.com/@comunidadehubconnect) -- [dSantana Automações](https://www.youtube.com/channel/UCG7DjUmAxtYyURlOGAIryNQ?view_as=subscriber) -- [Edison Martins](https://www.youtube.com/@edisonmartinsmkt) -- [Astra Online](https://www.youtube.com/@astraonlineweb) -- [MKT Seven Automações](https://www.youtube.com/@sevenautomacoes) -- [Vamos automatizar](https://www.youtube.com/vamosautomatizar) +[**Evolution API VPS — HostGator**](https://evolution-api.com/vps-evolution-api) + +--- + +## Telemetry + +Evolution API collects anonymous telemetry data (routes used, most accessed routes, API version) to help improve the service. **No sensitive or personal data is collected.** This information helps us identify improvements and provide a better experience for users. + +--- + +## Contributing + +Contributions are welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to submit issues, propose features, and open pull requests. + +Join our [community](https://evolutionfoundation.com.br/community) to discuss ideas and collaborate. + +--- + +## Security + +For security issues, **do not open a public issue**. Email **suporte@evofoundation.com.br** or use GitHub's private vulnerability reporting. See [SECURITY.md](./SECURITY.md) for details. + +--- + +## Acknowledgments + +- [CodeChat](https://github.com/code-chat-br/whatsapp-api) — original WhatsApp API foundation +- [Baileys](https://github.com/WhiskeySockets/Baileys) — WhatsApp Web library + +--- ## License -Evolution API is licensed under the Apache License 2.0, with the following additional conditions: +Evolution API is licensed under the Apache License 2.0, with additional brand-protection conditions (LOGO/copyright preservation and Usage Notification requirement). See [LICENSE](./LICENSE) for full details. + +For licensing inquiries, contact **suporte@evofoundation.com.br**. -1. **LOGO and copyright information**: In the process of using Evolution API's frontend components, you may not remove or modify the LOGO or copyright information in the Evolution API console or applications. This restriction is inapplicable to uses of Evolution API that do not involve its frontend components. +## Trademarks -2. **Usage Notification Requirement**: If Evolution API is used as part of any project, including closed-source systems (e.g., proprietary software), the user is required to display a clear notification within the system that Evolution API is being utilized. This notification should be visible to system administrators and accessible from the system's documentation or settings page. Failure to comply with this requirement may result in the necessity for a commercial license, as determined by the producer. +"Evolution Foundation", "Evolution" and "Evolution API" are trademarks of Evolution Foundation. See [TRADEMARKS.md](./TRADEMARKS.md) for the brand assets policy. -Please contact contato@evolution-api.com to inquire about licensing matters. +Third-party attributions are documented in [NOTICE](./NOTICE). -Apart from the specific conditions mentioned above, all other rights and restrictions follow the Apache License 2.0. Detailed information about the Apache License 2.0 can be found at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0). +--- -© 2025 Evolution API ++ Made by Evolution Foundation · © 2026 +
diff --git a/SECURITY.md b/SECURITY.md index 0e3189d2fb..a3dc1e5968 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,99 +1,68 @@ # Security Policy -## Supported Versions - -We actively support the following versions of Evolution API with security updates: - -| Version | Supported | -| ------- | ------------------ | -| 2.3.x | ✅ Yes | -| 2.2.x | ✅ Yes | -| 2.1.x | ⚠️ Critical fixes only | -| < 2.1 | ❌ No | +Evolution Foundation takes the security of Evolution API seriously. We +appreciate your efforts to responsibly disclose any vulnerabilities you find. ## Reporting a Vulnerability -We take security vulnerabilities seriously. If you discover a security vulnerability in Evolution API, please help us by reporting it responsibly. - -### 🔒 Private Disclosure Process - -**Please DO NOT create a public GitHub issue for security vulnerabilities.** - -Instead, please report security vulnerabilities via email to: - -**📧 contato@evolution-api.com** - -### 📋 What to Include +**Please do NOT open a public GitHub issue for security vulnerabilities.** -When reporting a vulnerability, please include: +Instead, report them privately through one of the following channels: -- **Description**: A clear description of the vulnerability -- **Impact**: What an attacker could achieve by exploiting this vulnerability -- **Steps to Reproduce**: Detailed steps to reproduce the issue -- **Proof of Concept**: If possible, include a minimal proof of concept -- **Environment**: Version of Evolution API, OS, Node.js version, etc. -- **Suggested Fix**: If you have ideas for how to fix the issue +### Preferred channels -### 🕐 Response Timeline +1. **GitHub Private Vulnerability Reporting** — use the "Security" tab on this + repository to submit a private advisory. -We will acknowledge receipt of your vulnerability report within **48 hours** and will send you regular updates about our progress. +2. **Email** — send your report to **suporte@evofoundation.com.br** with the + subject line `[SECURITY] Evolution API —