Enspace
    Enspace
    • Introdução
    • Autenticação
    • Conceitos
    • Primeiros Passos
    • Workspaces
      • Categorias
        • Campos
          • Listar campos
          • Criar campo
          • Obter campo específico
          • Atualizar campo
          • Excluir campo
        • Items
          • Listar items
          • Criar novo item
          • Contar items
          • Obter item específico
          • Atualizar item
          • Remover item
        • Listar categorias
        • Contar categorias
        • Obter categoria específica
        • Criar categoria
        • Atualizar categoria
        • Excluir categoria
      • Membros
        • Listar membros
        • Contar membros
        • Obter membro
        • Novo membro
        • Atualizar membro
        • Remover membro
      • Cargos
        • Listar cargos
        • Criar cargo
        • Obter cargo específica
        • Contar cargos
        • Atualizar cargo
        • Excluir cargo
        • Listar Permissões da Role
        • Adicionar Permissão à Role
        • Remover Permissão da Role
      • Grupos de Membros
        • Listar grupos
        • Novo grupo
        • Obter grupo
        • Atualizar grupo
        • Excluir grupo
      • Listar Workspaces
        GET
      • Contexto do Workspace
        GET
      • Novo Workspace
        POST
      • Sair do workspace
        POST
      • Estatísticas do Workspace
        GET
      • Prévia de Exclusão do Workspace
        GET
      • Excluir Workspace
        DELETE
    • Usuário
      • Logs de Auditoria
        GET
      • Listar Chaves de API
        GET

    Primeiros Passos

    ▶️ Primeiros Passos#

    Vamos criar sua primeira integração com a API ENSPACE! Este tutorial vai te guiar através dos conceitos básicos com exemplos práticos.

    🎯 O que vamos construir?#

    Vamos criar um catálogo de produtos simples que demonstra os principais conceitos:
    1.
    ✅ Configurar autenticação
    2.
    ✅ Criar um Type "Produto"
    3.
    ✅ Adicionar Fields ao Type
    4.
    ✅ Criar alguns Items (produtos)
    5.
    ✅ Listar e buscar produtos

    📋 Pré-requisitos#

    ✅ Token de API gerado (veja como)
    ✅ ID do workspace
    ✅ Ferramenta para fazer requisições (Postman, cURL, etc.)

    Configuração base#

    ENSPACE_API_KEY=en.ushcHQHcREdPpe3ZKFCSfAASFE5VawTwTH
    ENSPACE_API_URL=https://api.leif.enspace.io
    ENSPACE_WORKSPACE_ID=ws-123

    🔧 Passo 1: Testar Autenticação#

    Primeiro, vamos confirmar que nossa autenticação está funcionando:
    Resposta esperada:
    [
      // Lista dos types existentes (pode estar vazia)
    ]
    ✅ Sucesso! Se recebeu um array (mesmo vazio), a autenticação está funcionando.
    ❌ Erro? Verifique:
    Token está correto
    Workspace ID está correto
    Headers estão sendo enviados

    📊 Passo 2: Criar um Type "Produto"#

    Vamos criar nosso primeiro modelo de dados:
    Resposta:
    {
      "id": 1,
      "slug": "produto",
      "name": "Produto",
      "description": "Catálogo de produtos da empresa",
      "active": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "workspace": {
        "id": "ws-123",
        "name": "Seu Workspace"
      }
    }
    🎉 Ótimo! Nosso Type foi criado com sucesso.

    🏷️ Passo 3: Adicionar Fields#

    Agora vamos adicionar campos ao nosso Type:

    Campo: Nome do Produto#

    Campo: Preço#

    Campo: Categoria#

    Campo: Disponível#

    ✅ Excelente! Agora temos um Type completo com 4 campos.

    📄 Passo 4: Criar Items (Produtos)#

    Vamos adicionar alguns produtos ao nosso catálogo:

    Produto 1: iPhone 15#

    Produto 2: Camiseta#

    Produto 3: Mesa de Escritório#

    🛍️ Perfeito! Temos 3 produtos no nosso catálogo.

    📋 Passo 5: Listar e Buscar Produtos#

    Listar todos os produtos#

    Resposta:
    [
      {
        "id": 1,
        "reference": "PROD-001",
        "status": "active",
        "data": {
          "nome": "iPhone 15",
          "preco": 4999.99,
          "categoria": "eletrônicos",
          "disponivel": true
        },
        "type": {
          "id": 1,
          "slug": "produto",
          "name": "Produto"
        },
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
      },
      // ... outros produtos
    ]

    Buscar um produto específico#

    Listar com paginação e ordenação#

    Contar total de produtos#

    Resposta: 3

    🔄 Passo 6: Atualizar um Produto#

    Vamos marcar a mesa como disponível:
    💡 Dica: Você só precisa enviar os campos que quer atualizar!

    🎯 Exemplo Completo em JavaScript#

    Aqui está um exemplo completo de como usar a API em JavaScript:

    🎉 Parabéns!#

    Você acabou de criar sua primeira integração com a API ENSPACE!

    O que você aprendeu:#

    ✅ Autenticação - Como usar tokens e headers obrigatórios
    ✅ Types - Como criar modelos de dados personalizados
    ✅ Fields - Como definir a estrutura dos seus dados
    ✅ Items - Como criar, listar, buscar e atualizar dados
    ✅ Paginação - Como navegar por grandes conjuntos de dados

    🚀 Próximos Passos#

    1.
    Explorar Membros - Gerencie usuários do workspace
    2.
    Trabalhar com Roles - Configure permissões
    3.
    API Reference - Explore todos os endpoints disponíveis
    4.
    Webhooks - Configure integrações em tempo real
    5.
    SDKs - Use nossas bibliotecas oficiais

    💡 Dicas Avançadas#

    Filtros personalizados#

    Campos específicos#

    Busca por texto#

    Parabéns por chegar até aqui! Agora você tem uma base sólida para usar a API ENSPACE. 🚀
    Página anterior
    Conceitos
    Próxima página
    Workspaces
    Built with