Ir para o conteúdo

Documentação para programadores

Uma plataforma.
Quatro formas de desenvolver.

Use REST para integrações estruturadas, MCP para agentes de IA, a Theme API para a apresentação e plugins para as funcionalidades do site. Explore os contratos versionados e a disponibilidade de cada interface.

eyivo / programadores
GET /api/v1/sites 200
POST /api/v1/sites/{site}/pages 201
MCP list-sites-tool ok

Começar a desenvolver

Escolha a interface de integração adequada.

Cada guia começa pelo contrato da interface e avança para a configuração, exemplos práticos, validação e utilização em produção.

Já disponível v1 · API de conteúdo

REST API

Gerencie páginas, componentes, blogs, produtos, galerias, vídeos, menus, mídia, formulários e configurações do site com ferramentas e endpoints REST protegidos por permissões.

  • Tokens de acesso pessoais
  • OAuth 2.0 + PKCE
  • Acesso com permissões delimitadas
  • Operações de escrita idempotentes
Já disponível v1 · Liquid

Theme API

Crie temas portáteis com modelos Liquid, definições estruturadas, componentes reutilizáveis e conteúdo de demonstração completo.

  • Modelos Liquid
  • Definições do tema
  • 29 componentes partilhados
  • Conteúdo de demonstração
Já disponível v1 · Ferramentas e recursos

MCP

Gerencie páginas, componentes, blogs, produtos, galerias, vídeos, menus, mídia, formulários e configurações do site com ferramentas e endpoints REST protegidos por permissões.

  • Streamable HTTP
  • OAuth 2.0 + PKCE
  • Tokens pessoais
  • Propriedade do website
Apenas pacotes Eyivo Plugin API v1

Plugins

Amplie as funcionalidades do site através de hooks declarados, validação de formulários e uma ponte API controlada. O contrato v1 é público; atualmente só é possível instalar pacotes Eyivo.

  • Hooks do ciclo de vida
  • Validação de formulários
  • Páginas do painel
  • Execução restrita

Concebido para ser estável

Contratos de interface em que pode confiar.

A Eyivo define limites de integração claros para facilitar os testes, as atualizações e a operação das suas aplicações, agentes, temas e plugins.

01

Interfaces com versões definidas

As rotas REST e os manifestos de temas e plugins declaram a versão do contrato que utilizam.

02

Acesso com o mínimo de privilégios

As credenciais da API têm permissões explícitas e estão limitadas à conta autenticada.

03

Esquemas legíveis por máquina

O documento OpenAPI 3.1 é a referência principal para operações e esquemas REST.

04

Publicação segura

Os fluxos de conteúdo separam as alterações do website público quando o contrato assim o exige.