Uma API (Application Programming Interface) permite que os desenvolvedores criem integrações e aplicativos que podem se conectar ao seu site do Squarespace.
Neste guia, você aprenderá sobre a API do Squarespace e as chaves API exclusivas.
Este guia fornece uma visão geral das chaves API do Squarespace. Para obter informações detalhadas, visite a documentação do desenvolvedor da API.
Para obter ajuda com o Zapier, visite Adicionar integrações de formulários com o Zapier.
A API do Squarespace é um recurso Premium:
- A API de formulários (para integração com o Zapier) está disponível nos planos Business e Commerce.
- A API de pedidos está disponível no plano Commerce Advanced.
- A API de inventário está disponível no plano Commerce Advanced.
- A API de transações está disponível no plano Commerce Advanced.
Sobre a nossa API
O que você pode construir
Com nossa API, você pode criar integrações diretas com outros softwares. Crie uma chave API de formulários para usar nossa integração com o Zapier ou crie uma chave API de pedidos, inventário ou transações para criar suas próprias ferramentas personalizadas do Commerce.
Usando os dados aos quais fornecemos acesso por meio da nossa API, você pode:
- Conecte-se a um aplicativo de processamento ou envio de terceiros
- Sincronize seu inventário com outros canais de vendas ou sistemas de gerenciamento de inventário
- Enviar um e-mail de confirmação de pedido por meio de software externo
- Automatizar impressão de etiquetas de envio
- Automatizar a contabilidade
- Conectar-se à nossa integração Zapier
Observação: atualmente, nossa API não oferece suporte à autenticação OAuth para aplicativos de terceiros.
Segurança da chave API
A chave exclusiva de API é uma string aleatória de caracteres que permite acesso autenticado à sua conta do Squarespace.
Para criar uma nova chave:
- No Menu Inicial, clique em Configurações, depois em Avançado.
- Clique em Chaves API do desenvolvedor.
- Clique em Gerar chave.
- Informe um Nome de chave.
- Em Permissões, marque Pedidos, Formulários, Inventário ou Transações. Os Formulários estão disponíveis no plano Business ou superior. Pedidos, Inventário e Transações só estão disponíveis no plano Commerce Advanced.
- Selecione as permissões da chave API.
- Clique em Avançar.
- Copie sua chave API exclusiva.
Quando você receber esta chave:
- Mantenha-a segura. Trate sua chave API como trataria qualquer senha de conta.
- Copie e salve nos seus registros. Por segurança, não armazenamos sua chave de API. Não é possível recuperá-la após você fechar a janela, mas caso a perca, é sempre possível criar uma nova.
Você pode seguir essas etapas novamente para criar várias chaves.
Integração ao Zapier
Você pode conectar Blocos de Formulário, Blocos de Newsletter e Formulários de Página de Entrada à ferramenta de automação online Zapier. Isso permite que você crie Zaps, um tipo de fluxo de trabalho automatizado, que usa envios de formulário para acionar integrações adicionais do Zapier, como Slack, Trello, ConvertKit, Salesforce e muito mais. Isso pode ajudar você a economizar tempo ao conectar o Squarespace a ferramentas úteis e automatizar processos.
Para ajuda, acesse Adição de integração de formulário com o Zapier.
APIs do Commerce
Use as APIs do Commerce para sincronizar os dados de pedido, inventário e transação da sua loja com serviços de terceiros. Essa é uma ótima maneira de conectar sua loja do Squarespace a outros serviços que você usa para gerenciar sua empresa e automatizar tarefas importantes, como envio e arquivamento de impostos. Saiba mais sobre como usar essas APIs em nossa documentação do desenvolvedor:
- API de inventário – Sincronize seu inventário do Squarespace com sistemas de gerenciamento de inventário.
- API de pedidos – Sincronize seus pedidos do Squarespace com serviços de envio e processamento. Você também pode usar a API de registro de pedidos para importar pedidos de canais de vendas de terceiros.
- API de transações – Sincronize suas transações e doações do Squarespace com serviços de contabilidade.
Não é possível usar a API do Commerce para conectar um processador de pagamento de terceiros. Você só pode usar Stripe, PayPal ou Square para Ponto de Venda para processar pedidos feitos em seu site.
Revogar uma chave API
Para revogar uma chave API, exclua-a no painel Chaves API do Squarespace:
- No Menu Inicial, clique em Configurações, depois em Avançado.
- Clique em Chaves API do desenvolvedor.
- Clique no ícone de lixeira ao lado da Chave API que deseja revogar.
- Clique em Confirmar.
A exclusão de uma chave API interrompe a conexão entre seu site e o aplicativo ou serviço que usa a chave para acessar os dados do site. O aplicativo ou serviço ainda pode ter dados que você enviou enquanto a API estava conectada. Entre em contato diretamente com o desenvolvedor para gerenciar seus dados históricos.
Perguntas frequentes
Posso criar uma integração usando a API?
Nossas APIs oferecem suporte a uma grande variedade de casos de uso. Para confirmar que uma integração é possível, visite nossa documentação do desenvolvedor.
Quais integrações de terceiros estão disponíveis para as APIs de Pedidos e Inventário?
As APIs de Pedidos e Inventário foram projetadas para que os comerciantes criem suas próprias integrações personalizadas. Veja as extensões oficiais criadas por serviços de terceiros no Squarespace Extensions.
Solução de problemas e suporte
APIs do Commerce
Para obter ajuda para usar as APIs do Squarespace Commerce, acesse o nosso Site de Desenvolvedor, que tem documentação detalhada sobre todas as nossas APIs públicas. Se ainda tiver dúvidas, entre em contato conosco.
Chaves de API
Recomendamos estes primeiros passos ao solucionar problemas com chaves API:
- Veja se você está usando o tipo certo de chave API. Por exemplo: você só pode usar a API de formulários para criar uma integração de formulários.
- Se um formulário ou pedido específico não aparecer, veja se você criou a chave API do site correto.
- Se o formulário não aparecer no Zapier, e a chave API for do site correta, apague o formulário no Squarespace e adicione um novo.
Erros no CORS
Você verá um erro CORS (Cross Origin Resource Sharing) se usar JavaScript para fazer solicitações de um navegador. Todas as solicitações devem ser originadas de um aplicativo do lado do servidor. Não aceitamos solicitações de CORS.