Principal API e Webhook

API e Webhook

Por Henri and 1 outro
4 artigos

O que são a API INK e o webhook

A API INK e o webhook servem para a sua loja conversar com outras ferramentas que você usa, como um CRM, uma ferramenta de dados, uma automação ou um sistema próprio. Em vez de você abrir o painel e conferir tudo na mão, o outro sistema consulta e recebe as informações direto da INK. São dois recursos técnicos. Para usá-los, alguém precisa configurar a conexão do outro lado: normalmente quem cuida da ferramenta que você usa, um integrador ou alguém do seu time que mexe com isso. Se você não usa nenhuma outra ferramenta hoje, não precisa de nenhum dos dois. A diferença entre eles em uma frase: o webhook avisa, a API executa. Os detalhes técnicos dos dois, com endereços, autenticação, formato dos dados e exemplos, ficam no portal de documentação em ++developers.reserva.ink++. É a página para mandar para quem vai fazer a conexão. A API INK A API INK é o caminho para outro sistema ler e alterar os dados da sua loja sem passar pelo painel. O que dá para fazer por ela hoje: - Consultar pedidos, com filtro por status de entrega - Consultar clientes, contatos da newsletter e carrinhos abandonados - Consultar o financeiro: saldo, extrato, saques e antecipações (só consulta, sem criar saque ou antecipação pela API) - Criar, editar e excluir produtos, incluindo criar produto com arte por URL - Criar, editar e excluir categorias e coleções, incluindo kits e vitrine - Criar, editar e excluir promoções - Consultar e criar trocas e reembolsos Como liberar o acesso 1. No seu painel, clique em Credenciais de API. 2. Gere uma credencial e escolha o que ela pode fazer, item por item: só consultar pedidos, criar produtos, e assim por diante. 3. Guarde o código secreto que aparece na criação. Ele é exibido uma única vez. Se você perder, precisa gerar outra credencial. 4. Entregue a credencial para quem vai fazer a conexão do outro lado. Na mesma tela você lista as credenciais que já criou, renomeia e revoga. Revogar corta o acesso na hora: as chamadas feitas com aquela credencial passam a ser recusadas. O que é bom saber antes - A credencial só enxerga e altera dados da sua própria loja, nunca de outra. - Cada credencial faz só o que os itens marcados na criação permitem. - Existe um limite de chamadas por minuto. Se o outro sistema passar do limite, as chamadas são recusadas até o minuto seguinte. O número está no portal de documentação. - API e Webhook estão disponíveis apenas para lojistas do plano Inkrível. Se você sair do Inkrível, as credenciais da loja são revogadas e a conexão para de funcionar. O webhook O webhook é o contrário da API: em vez de o outro sistema perguntar à INK se algo aconteceu, a INK avisa esse sistema na hora em que acontece. Você informa um endereço, escolhe os eventos que quer acompanhar e, a cada evento, a INK envia os dados daquele acontecimento para lá. Serve, por exemplo, para o seu sistema registrar a venda no momento em que o pagamento é confirmado, em vez de ficar consultando a lista de pedidos de tempo em tempo. Como cadastrar 1. No seu painel, clique em Credenciais de Webhook. 2. Cadastre um webhook. 3. Informe o endereço que vai receber os avisos, o método e, se quiser, um código secreto para o seu sistema confirmar que o aviso veio mesmo da INK. 4. Marque os eventos que você quer acompanhar. Eles aparecem agrupados por assunto. 5. Salve. Cada evento marcado vira um webhook separado, com o mesmo endereço, método e código secreto. Eventos disponíveis hoje Pedido e pagamento: - Pedido criado no checkout - Pagamento confirmado - Cartão não autorizado pela operadora - Pix ou boleto expirado - Pedido cancelado ou reembolsado Entrega: - Pedido produzido, aguardando envio - Pedido despachado - Pedido em trânsito - Pedido saiu para entrega - Pedido entregue - Falha na entrega Carrinho: - Carrinho abandonado, com os itens do carrinho Cada aviso chega com os dados daquele acontecimento. No pagamento confirmado, por exemplo, vão a forma de pagamento, a previsão de entrega, a transportadora e o seu lucro naquele pedido. Qual dos dois eu uso? - Quer que outro sistema puxe ou mude informação da loja quando ele quiser: API. - Quer ser avisado no instante em que algo acontece na loja: webhook. - Na maioria das integrações, os dois juntos.

Última atualização em Sep 03, 2026

Como gerar e gerenciar a credencial de API INK

A credencial é a chave que permite outro sistema acessar os dados da sua loja pela API INK. Sem ela, nenhuma integração funciona. Neste artigo você vê como criar, como escolher o que ela pode fazer, como cuidar dela e como cortar o acesso quando precisar. A API INK está disponível apenas no plano Inkrível. Em outro plano, o painel mostra a opção de upgrade em vez da criação de credencial. Como criar 1. No seu painel, clique em Credenciais de API. 2. Clique em criar uma nova credencial e dê um nome que diga para que ela serve, por exemplo "sistema de gestão" ou "planilha de vendas". Esse nome é só para você se organizar depois. 3. Marque o que a credencial pode fazer. As permissões são separadas por assunto e por tipo de acesso: consultar ou alterar. Você marca, por exemplo, consultar pedidos e alterar produtos, e deixa o resto de fora. 4. Salve. A INK mostra o identificador e o código secreto da credencial. 5. Copie o código secreto e guarde num lugar seguro. Ele aparece uma única vez. Se você fechar a tela sem copiar, não tem como recuperar, só criar outra credencial. 6. Entregue o identificador e o código secreto para quem vai montar a conexão, junto com o endereço da documentação, developers.reserva.ink. O que dá para fazer depois de criar Na mesma tela ficam as credenciais que você já criou. Ali você: - Vê a lista, com o nome e as permissões de cada uma. - Renomeia, se o nome não estiver mais dizendo o que é. - Revoga, quando quiser cortar o acesso. Revogar tem efeito imediato: as chamadas feitas com aquela credencial passam a ser recusadas na hora. Use isso quando desligar uma integração, trocar de fornecedor ou suspeitar que o código secreto vazou. Não existe como ver o código secreto de novo depois da criação, nem para você. Se ele foi perdido, o caminho é criar uma credencial nova e revogar a antiga. Segurança: cinco cuidados que evitam problema Marque só o que a integração precisa. Uma credencial que só lê pedidos não consegue apagar produto, mesmo se o código do outro lado tiver erro ou for usado por outra pessoa. É a proteção mais simples e a mais eficiente. Uma credencial por integração. Se a mesma chave alimenta o sistema de gestão, a planilha e a automação, você não consegue desligar uma sem derrubar as outras três. Separando, dá para revogar uma coisa por vez e você também descobre qual integração está causando problema. Comece com uma credencial só de consulta. Ao montar ou testar uma conexão, crie primeiro uma credencial sem permissão de alteração. Confira se o outro lado está lendo os dados certos e só depois gere uma com permissão de alterar. Não coloque a credencial no site nem no aplicativo. Ela só deve existir no servidor ou na ferramenta que faz a conexão. Se ela aparecer no código do site, qualquer visitante consegue ler. Revogue quando alguém sai. Se quem montou a integração era um fornecedor ou alguém do time que saiu, revogue e crie outra credencial. Ela vale para a loja, não para a pessoa. O que mais é bom saber - A credencial só enxerga e altera dados da sua própria loja. - Existe um limite de chamadas por minuto. Se o outro sistema passar do limite, as chamadas são recusadas até o minuto seguinte. O número está no portal de documentação. - Em toda operação que altera dados, a API exige uma identificação da chamada, chamada chave de idempotência. Ela evita que a mesma coisa seja criada duas vezes se a chamada for repetida. Quem monta a conexão cuida disso. - Se a sua loja sair do plano Inkrível, as credenciais são revogadas e as integrações param de funcionar.

Última atualização em Sep 03, 2026

Como cadastrar e gerenciar os webhooks da sua loja

O webhook faz a INK avisar outro sistema no momento em que algo acontece na sua loja, em vez de esse sistema ficar perguntando de tempo em tempo. Você informa um endereço, escolhe os eventos e a INK envia os dados para lá a cada acontecimento. O webhook está disponível apenas no plano Inkrível. Como cadastrar 1. No seu painel, clique em Credenciais de Webhook. 2. Cadastre um novo webhook. 3. Informe o endereço que vai receber os avisos. É um endereço do sistema ou da automação do outro lado, não um site seu. 4. Escolha o método de envio. Quem montou o outro lado sabe qual usar. 5. Informe um código secreto, se quiser. Ele não é obrigatório, mas é o que permite ao seu sistema confirmar que o aviso veio mesmo da INK e não de outra pessoa que descobriu o endereço. Se a integração aceitar, use. 6. Defina o status. 7. Marque os eventos que você quer acompanhar. Eles aparecem agrupados por assunto, e você pode marcar vários de uma vez. 8. Salve. Cada evento marcado vira um webhook separado na lista, todos com o mesmo endereço, método, status e código secreto. Marcar seis eventos cria seis webhooks. Isso é o esperado, não é erro. Os eventos disponíveis São 15 eventos hoje. Cada aviso chega com os dados daquele acontecimento. Pedido e pagamento - Pedido criado no checkout - Pagamento confirmado, com a forma de pagamento, a previsão de entrega, a transportadora e o seu lucro no pedido - Cartão não autorizado pela operadora - Pix ou boleto expirado - Pedido cancelado ou reembolsado Entrega - Pedido produzido, aguardando envio - Pedido despachado - Pedido em trânsito - Pedido saiu para entrega - Pedido entregue - Falha na entrega Alterações no pedido - Itens alterados na janela de 2 horas, com o item anterior, o item novo e quem alterou - Endereço de entrega alterado, com o endereço anterior, o novo, quem alterou e quando - Pedido com produto personalizado parado há mais de 24 horas, com os itens pendentes e a ação necessária Carrinho - Carrinho abandonado, com os itens que ficaram no carrinho Os eventos de pedido valem também para os pedidos que entram pelas suas integrações de loja, não só para os do checkout da INK. O carrinho abandonado funciona diferente dos outros. Em vez de um aviso só, ele avisa em quatro momentos, 30 minutos, 8 horas, 16 horas e 24 horas depois do abandono, e cada aviso informa em qual desses momentos ele está. Cada momento é enviado uma única vez por carrinho, e se a compra for concluída os avisos seguintes não são enviados. Isso serve para montar uma régua de recuperação com mensagens diferentes em vez de um disparo único. O que exatamente vem em cada aviso, em que formato e como confirmar a origem com o código secreto está no portal de documentação, em developers.reserva.ink. Como gerenciar depois Na lista você vê todos os webhooks cadastrados, com endereço e evento. Abrindo um deles, dá para alterar o endereço, o método, o código secreto e o status. Na edição, cada webhook está ligado a um evento só. Ou seja: você marca vários eventos na criação, mas ajusta um por um depois. Para acompanhar um evento novo, cadastre outro webhook com o mesmo endereço. Os dois erros mais comuns Salvar sem marcar nenhum evento. O cadastro não é criado e a tela avisa. Volte e marque pelo menos um. Repetir um evento que já existe no mesmo endereço. Se qualquer um dos eventos marcados já estiver cadastrado naquele endereço, nenhum dos outros é criado e a tela avisa que o endereço já está em uso. Confira na lista o que você já tem antes de cadastrar de novo, e marque só os eventos que faltam. Antes de sair do painel Peça para quem montou o outro lado confirmar que os avisos estão chegando. O cadastro no painel garante que a INK vai enviar, não que o sistema do outro lado está recebendo e entendendo. Vale testar com um evento fácil de provocar, como um pedido de teste, antes de contar com o fluxo.

Última atualização em Sep 03, 2026

Cinco coisas para montar com a API INK e o webhook

A API INK e o webhook abrem os dados da sua loja para outras ferramentas. Este artigo mostra cinco usos concretos, com o que você precisa, como montar e o que observar em cada um. Duas coisas antes de começar, para não haver surpresa. Nenhuma ferramenta tem conexão pronta com a INK. Não existe um botão de conectar. Alguém precisa montar a ligação, usando a API INK e o webhook de um lado e a API da outra ferramenta do outro. Pode ser o seu integrador, alguém do seu time que mexe com isso, ou uma ferramenta de automação, que serve de ponte e reduz bastante o trabalho. A API INK e o webhook estão disponíveis apenas no plano Inkrível. A ferramenta do outro lado também pode cobrar por isso: no Sistema ERP da Olist, o antigo Tiny, as integrações via API só estão disponíveis a partir do plano Construa. Confira o plano dos dois lados antes de contratar qualquer coisa. A ferramenta de automação no meio Se ninguém do seu time programa, é por aqui que vale começar. A automação recebe o aviso do webhook da INK e joga o dado na outra ferramenta, com configuração em tela em vez de código. Ela aparece em todos os cinco casos abaixo. - n8n. Mais flexível e dá para rodar no seu próprio servidor. Boa escolha para fluxo com muitas condições. - Zapier. O mais simples de começar, com muitos aplicativos já prontos do outro lado. Nas três, a INK entra como webhook de entrada e chamada de API na saída, não como aplicativo pronto na lista. 1. Avisar o cliente sobre o status da entrega Para quem recebe muito "onde está meu pedido". O que você precisa: webhook nos eventos de entrega, uma plataforma de WhatsApp com provedor oficial ou uma ferramenta de email, e uma automação no meio. Como montar: cadastre os eventos de entrega que interessam. Nem todos precisam virar mensagem, e despachado, saiu para entrega e entregue costumam dar conta. Cada aviso traz o pedido e o estágio, e a automação dispara a mensagem correspondente. Sobre o WhatsApp: ele não é acessado direto pela Meta. Você contrata um provedor homologado, chamado BSP, que ativa e configura a conta, e as mensagens saem a partir de modelo aprovado. Take Blip e Zenvia são brasileiros e atendem desde PME até grande operação. 360dialog tem modelo mais direto com a Meta. Twilio e Infobip são globais e mais indicados para operação internacional. A lista oficial e atualizada fica no diretório de parceiros da Meta. Usar intermediário não homologado aumenta o risco de bloqueio do seu número. O que observar: mensagem em excesso irrita e faz o cliente bloquear o contato. E o evento de falha na entrega merece tratamento diferente dos outros, porque ali a mensagem automática resolve pouco e a pessoa quer falar com alguém. Vale mandar esse para o seu atendimento em vez de para o cliente. Junto com esse caso vale ligar os avisos que não são para o cliente e sim para o seu time: pedido com produto personalizado parado há mais de 24 horas, item alterado na janela de 2 horas e endereço de entrega alterado. Uma automação joga esses três no canal onde o time já trabalha. 2. Recuperar cliente e pedido que ficaram no caminho Para quem perde venda de gente que chegou perto de fechar. O que você precisa: webhook nos eventos de carrinho abandonado, cartão não autorizado e Pix ou boleto expirado, uma ferramenta de email ou de WhatsApp e uma automação no meio. Como montar: são três situações diferentes e cada uma pede uma mensagem própria. - Carrinho abandonado: o aviso traz os itens que ficaram no carrinho, então a mensagem pode mostrar exatamente o que a pessoa deixou para trás em vez de um lembrete genérico. - Cartão não autorizado: a pessoa já decidiu comprar e o problema foi o meio de pagamento. Oferecer outra forma resolve boa parte. - Pix ou boleto expirado: aqui basta gerar de novo. É a recuperação mais fácil das três e a que menos gente faz. Do lado da ferramenta de email ou CRM, a API INK também entrega a sua base de clientes e os contatos que se cadastraram na newsletter, o que permite montar a audiência antes de ligar a régua. No Mailchimp, a API cria e atualiza contatos, aplica etiquetas e aceita eventos de fora como gatilho de automação. No RD Station Marketing, cada aviso da INK entra como uma conversão com identificador próprio, então "carrinho abandonado" e "pedido entregue" viram gatilhos diferentes lá dentro. O que observar: comece pelos dois de pagamento. São menos mensagens, o público é menor e a conversão é maior que a de carrinho, porque a intenção de compra já estava confirmada. Deixe o carrinho abandonado para depois, quando você já souber que o fluxo funciona. 3. Emitir a nota fiscal do seu lucro no Tiny Para quem precisa emitir nota da sua parte da venda. A INK emite a nota referente ao valor do produto. A nota do seu lucro é sua responsabilidade, e esse é o caso em que a integração poupa mais trabalho repetitivo. O que você precisa: credencial de API com permissão de consultar pedidos e clientes, webhook no evento de pagamento confirmado, o Sistema ERP da Olist, o antigo Tiny, com API liberada, e uma automação no meio. Como montar: o aviso de pagamento confirmado chega já com o seu lucro naquele pedido, que é justamente o valor que a nota precisa. A automação recebe o aviso, consulta pela API INK os dados do pedido e do comprador, e lança tudo no Olist, que emite a nota. A API do Olist cobre produtos, estoque, pedidos, notas fiscais, contas a pagar e receber e contatos, então o mesmo fluxo pode alimentar o seu financeiro com o saldo, o extrato, os saques e as antecipações que a API INK devolve. O que observar: fale com a sua contabilidade antes de ligar. Como classificar essa nota, qual natureza de operação usar e o que informar depende do seu regime, e isso não é algo que a INK possa definir para você. Rode com um pedido e confira a nota emitida antes de deixar o fluxo automático. 4. Dashboard de análise no Looker Studio Para quem exporta relatório toda semana e refaz a mesma planilha. O que você precisa: credencial de API só de consulta, uma planilha ou banco de dados, o Looker Studio e uma automação. Como montar: a automação puxa os dados pela API INK num horário fixo, uma vez por dia costuma bastar, e escreve numa planilha. O Looker Studio não conversa direto com a API INK, ele lê essa planilha e monta os gráficos em cima dela. Se quiser dado em tempo real, use o webhook de pedido criado e faça a automação escrever uma linha a cada aviso. O que dá para analisar: a API devolve pedidos com filtro por status de entrega, clientes, carrinhos abandonados, produtos, coleções, promoções e o financeiro da loja. Dá para cruzar venda por produto, por coleção, por promoção e por período, e ver quanto de carrinho abandonado virou venda. O que observar: use credencial só de consulta. Esse fluxo não precisa alterar nada na loja, e uma credencial sem permissão de alteração não consegue estragar nada mesmo se algo der errado. 5. Criação de produtos em massa Para quem vai subir uma coleção inteira e não quer cadastrar um por um no painel. Esse caso é diferente dos outros quatro. Não existe ferramenta de mercado que queira criar produto na sua loja INK, porque aqui não é a INK conversando com outro sistema, é a sua loja fazendo em lote o que você faria no painel um por um. Então não tem nome de ferramenta para citar do outro lado. O que a API permite: criar, editar e excluir produtos, com a arte informada por endereço de imagem; criar, editar e excluir categorias e coleções, incluindo kit e vitrine; criar, editar e excluir promoções. Programar campanha por horário e desligar tudo no fim entra aqui também. O que você precisa: credencial de API com permissão de alterar produtos, as artes publicadas em endereços de imagem acessíveis, uma planilha com os dados e uma automação. Como montar: 1. Monte a planilha com uma linha por produto, incluindo o endereço da arte. 2. Se ninguém do seu time programa, peça a uma ferramenta de IA, como Claude ou ChatGPT, o fluxo de n8n ou o script que faz isso, passando o endereço da documentação, developers.reserva.ink, para ela seguir o formato certo. 3. Cole o resultado na automação e rode ali. A ferramenta de IA escreve, ela não executa. O que observar: rode com uma linha primeiro e confira o produto no painel antes de soltar a planilha inteira. A arte vai por endereço de imagem, não por envio de arquivo. Os mockups são gerados depois da criação, então o produto não aparece completo no mesmo instante. E a INK não consegue dar suporte a script ou fluxo que você gerou: o suporte cuida da API e do webhook, do lado da INK. Por onde começar Se é a sua primeira integração, o caso 4 é o melhor primeiro passo. Ele usa credencial só de consulta, não mexe em nada da loja, e você já sai com resultado visível. Depois disso os outros ficam mais fáceis, porque a parte chata, entender como a API devolve os dados da sua loja, já está feita. O caminho é sempre o mesmo: 1. Confirme que a sua loja está no plano Inkrível. 2. No seu painel, clique em Credenciais de API e gere uma credencial, marcando só o que a conexão precisa fazer. 3. Se a ideia envolve reagir a acontecimentos, cadastre também os webhooks dos eventos que interessam. 4. Mande a credencial e o endereço da documentação, developers.reserva.ink, para quem vai montar a conexão.

Última atualização em Sep 03, 2026