O que é?
Por meio da API, dois softwares diferentes podem se comunicar mediante normas e padrões estabelecidos no sistema. A sigla se refere a “Application Programming Interface”, que traduzindo para português seria “Interface de programação de aplicação”.
As aplicações são, nesse contexto, qualquer software que tenha uma utilização única. Já a interface, se refere à conexão entre duas aplicações, assim estabelecem os padrões que serão a base da comunicação.
Diante disso, os desenvolvedores podem estruturar as solicitações e respostas usando as informações presentes na documentação das respectivas APIs.
Clicando aqui, você segue para a página que possibilita a criação de credenciais para autenticação na API da wap.store.
Como a API auxilia no dia a dia?
As APIs se comunicam basicamente como cliente e servidor, com a comunicação feita nas documentações ajuda a integrar uma plataforma na outra, sem dificuldades.
Todo sistema que for integrar na API deve criar credenciais diferentes, sejam eles parceiros, ERPs ou outras integrações.
Na wap.store, você pode contar com as informações da documentação para realizar a integração entre APIs de maneira simples. Com isso, os sistemas podem ser conectados e utilizados no dia a dia.
Para entender na prática a API na plataforma, é preciso acessar o módulo referente ao recurso, que pode ser visto em “Apps” > clicando no ícone de visualização.
O módulo permite criar nova integração e gerenciar as já existentes.
Criação de webhooks
Com as credenciais, também pode ser cadastrado um link externo, que receberá as notificações por webhook. Essas notificações servirão apenas de alerta, informando que existe um novo conteúdo a ser consumido nos endpoints de Produto, Pedido ou Cliente.
As configurações de APIs e webhooks da wap.store permitem definir a frequência da execução do envio de notificações, a quantidade de itens enviados em cada notificação por lote e por item.
Aprenda a definir a permissão de acesso para integrações
A Uappi possui um recurso que visa aprimorar a segurança na API v2. Para isso, em cada credencial de API (ou chave de API) criada, o lojista precisa definir quais endpoints estarão disponíveis para aquela chave de API.
Esse tipo de permissão permite que o lojista controle a ação que cada integrador pode ter.
Exemplo: um integrador, que precisa consumir os dados de cliente da loja para realizar ações de e-mail marketing, pode realizar as consultas nos endpoints destinados à exibição dos dados de cliente.
Esse integrador precisa somente consumir os dados de cliente, então, ele não vai precisar criar/alterar um cliente ou, então, atualizar um pedido e realizar outras ações. Com isso, é ideal não permitir esse acesso.
Como definir essa configuração, na prática?
As configurações de endpoints permitidas seguirão a sintaxe presente na documentação da API v2.
Sendo assim, para liberar somente a consulta de clientes, por exemplo, a permissão deve ser configurada para:
método: GET;
endpoint: v2/customers.
Caso seja para uma consulta específica de um cliente, a configuração seria desta forma:
método: GET;
endpoint: v2/customers/{idCodigoCliente}.
Importante: nos exemplos acima, se for inserida uma letra diferente do que está na documentação, o endpoint de consulta não será liberado para uso para aquele integrador.
Se estiver na documentação como "v2/customers/{idCodigoCliente}" e for configurado no painel como "v2/customers/{idCodigoClienteS}", só de adicionar a letra "S" a consulta de um cliente específico não será liberada.
Os métodos https (campo "Método" no módulo de permissão), também devem ser configurados conforme a documentação.
Acesse o recurso
Todos os endpoints que vão estar disponíveis para a chave de API serão listadas na tela de edição de uma das chaves de integração (chave de API).
As novas chaves de API criada tem todos os endpoints bloqueados, então, além de criar a chave de API, será preciso definir quais endpoints aquela chave de API terá permissão de acesso.
Essa configuração está presente em “Configurações” > “Integrações” > “API” > clicar no ícone de edição da integração desejada.
Na imagem abaixo você pode visualizar o ícone na listagem de API.
Após isso, descendo até o final da página, a configuração de “Endpoints permitidos na integração”.
As chaves de API criadas antes desta melhoria, continuam com todos os endpoints liberados. Para mudar isso, basta configurar um endpoint a ser liberado.
Lembre-se de digitar o endpoint corretamente para não ocorrer nenhum erro.
Após a configuração, clique em “Enviar” para salvar.
Para ver mais conteúdos sobre a plataforma da Uappi, acesse nossa base de conhecimento no freshdesk ou na central de ajuda!