Estamos integrados agora ao Whatsapp! Acompanhe isso e muito mais em nosso canal, com videos exclusivos e tutoriais imperdíveis.

Use e abuse

Documentação :. API

Todas as etapas para conectar seu sistema ao nosso.

Praticamente
todo profissional que já trabalhou com integrações, já ouviu falar do REST API, graças a sua adição de núcleo no final de 2020. No entanto, na maioria das vezes apenas os desenvolvedores mais experientes aproveitam o tempo para aprender o quão poderoso esse novo recurso pode ser. 
O REST API do SIG Cloud contém um wallop em toda instalação de atualização, provendo um API que pode ser integrado em softwares de CRM, aplicações móveis, e mais. Ele possibilita desenvolvedores separar a interface frontal da gestão de dados, permitindo qualquer interação com o SIG. Aprendendo como utilizar essa ferramenta, ela pode abrir portas para incontáveis possibilidades no seu software ou site usando o SIG

 

Neste artigo, vamos introduzir você ao projeto REST API, e mostrar o porque é um grande negócio, em seguida, oferecer algumas dicas sobre como usá-lo. Vamos começar.

Introdução ao REST API SIG Cloud

O Projeto SIG Cloud Representational State Transfer (REST) API afirma que está fazendo movimentos para se tornar um aplicativo de estrutura de aplicação completa, sua própria existência suporta essa reivindicação, pois acrescenta uma REST API padrão, no núcleo do SIG.

Como REST API do SIG funciona?

Em suma, a REST API funciona manipulando dados textuais de algum lugar para outro sem acesso direto a um banco de dados ou interface do usuário. Existem muitos tipos de interfaces de Programação de aplicativos (API’s), embora o REST se destaca como um padrão moderno.

REST API’s são distribuídas através das extremidades do HTTP (HyperText Transfer Protocol)
Utilizando javaScript Object Notation (JSON) para formatação, em termos simples, essas tecnologias proveem acesso a API usando um endereço web único para enviar dados que se comportam como Objetos JavaScript.

Se você nunca trabalhou com JavaScript ou notação de objetos antes, seria uma boa ideia começar aprendendo os conceitos Básicos de JSON. Uma vez que você estiver confortável com o conceito de uma REST API, vamos falar mais sobre o grande impacto e uso dessa ferramenta.

Passos para começar a trabalhar com o SIG Cloud REST API

Conforme abordamos anteriormente, o REST API pode ser usada com qualquer aplicativo ou linguagem de programação que possa chamar uma extremidade do HTTP, o que é a maioria delas. Portanto nós concentramos no uso da linha de comando para executar os pedidos da REST API, porque esse é o método mais simples e tem o menor número possível de erros programáticos para interromper sua aprendizagem.

Para fazer isso, você deseja abrir o programa dá interface de linha de comando (CLI) no seu computador. Terminal  no MacOS e linux e Prompt Comando no windows.  A CLI permite que interaja diretamente com a REST API sem precisar escrever scripts adicionais para solicitar e processar a informação.

Qualquer pedido que você fizer na CLI pode ser roteado para PHP, JavaScript e outros idiomas, mas o método variará para cada um. Dar comandos na CLI é fácil, basta digitar o comando desejado e pressionar ENTER no seu teclado.

Também recomendamos configurar um sig demo para testar, em vez de concluir esse tutorial em um sig ao vivo. Finalmente. O único requisito é que seu sig cloud esteja sendo executado na versão 4.2 ou superior, quando estiver pronto, vamos começar.

Etapa 1: Familiarize-se com os conceitos-chave da REST API

Antes de começar, é uma ideia inteligente se familiarizar com todas as partes móveis dá REST API. existem cinco conceitos e termos principais com os quais você deve estar familiarizado. Vamos examiná-los agora:

  • “Vias”/”rotas” e “Extremidades”/”pontos finais”: este é o aspecto mais importante dá REST API para entender. Os roteiros ajudam você a navegar através dos pontos finais que é quando  um método HTTP específico, por exemplo, um conjunto de dados estático ou uma ação, é conectada a uma rota específica. Por exemplo /api-json/ é uma rota configurada como um ponto final, projetado para nos mostrar rotas disponíveis.
  • SolicitaçõesEsses são feitos quando desencadeado os pontos de extremidade corretos e transmitindo dados.
  • Respostas: Em suma, isso fornece os dados que você solicitou ou retorna um erro para que você saiba que algo errado aconteceu.
  • Esquemas: Essas são as respostas dos modelos, então você sempre sabe exatamente onde procurar os dados certos.
  • Classes de controles: Em termos leigos, eles permitem que você crie suas próprias rotas e Extremidades. Por enquanto você não precisa se preocupar com isso, no entanto eles ficarão mais e mais úteis conforme o tempo.

Depois de entendido esses cinco conceitos, você pode já começar a se aprofundar a própria REST API começando pelos seus EndPoints.

Passo 2: Conheça o EndPoint mais úteis a REST API

O REST API do SIG oferece um manual de referência carregado com todos os EndPoints que você achará mais eficiente, primeiro você quer saber como construir uma chamada HTTP para o  REST API. A base de cada chamada do REST API do SIG Cloud é a seguinte, substituindo o marcador de posição, wascloud.com.br/[sua empresa] pelo seu próprio:

  http://wascloud.com.br/[sua empresa]/api-json/

Você pode testar sua conexão executando o comando curl em sua CLI usando seu próprio URL:

 

curl -X OPTIONS -i 

  http://wascloud.com.br/[sua empresa]/api-json/

Você deve ser recebido com uma mensagem HTTP de sucesso. Você pode então pode atualizar e repetir este comando usando vários dos principais pontos finais, dessa vez, simplesmente, usaremos a versão GET de curl.

Para pegar uma lista JSON de seus clientes do SIG Cloud, você pode usar o seguinte:

  curl -X GET -i http://wascloud.com.br/[sua empresa]/api-json/wp/v2/clients

Alternativamente, tente isso para verificar todos os clientes existentes do SIG:

  curl -X GET -i http://wascloud.com.br/[sua empresa]/api-json/wp/v2/leads

Você pode experimentar com cada um desses EndPoints (e mais) na CLI para rever o tipo de resposta retornada para cada um.

Etapa 3: Aprenda o básico dá autenticação do REST API

Agora é hora de aprender sobre autenticação. Algumas ações e dados dentro dá REST API são públicos, enquanto outros exigem que você seja logado como administrador. No entanto essa é uma REST API, portanto, não há onde entrar, em vez disso você pode autenticar-se ao fazer qualquer chamada que exija acesso administrativo, como visualização de conteúdo não publicado ou atualização de uma publicação.

Comece ativando no sig a funcionalidade REST API Basic Auth dentro de configurações->integração->API REST. esse é um simples botão de desenvolvedor a aprender rapidamente REST API, e não se destina apenas à softwares online. 

Uma vez que o Basic Auth esteja instalado, você poderá autenticar sobre a CLI com sua user Flag. aqui está um exemplo de como aplicar o método de autenticação do usuário Curl para visualizar posts inéditos.

 

curl -X GET –user username:password -i

http://wascloud.com.br/[sua empresa]/api-json/

v2/invoice?status=draft

A autenticação será necessária para qualquer outra coisa além da exibição das informações públicas. Depois de obter o atraso da autenticação básica, você pode explorar as outras opções recomendadas pela documentação da REST API para seu código de produção.

Conclusão

REST API do SIG Cloud é uma nova adição poderosa ao núcleo do SIG Cloud, e poucos desenvolvedores começam a arranhar a superfície de suas capacidades. Como consequência ficar a bordo, e aprender a trabalhar com ele, pode ajudar a transformá-lo em algo mais valioso como desenvolvedor e permite que você crie aplicativos usando o SIG como estrutura. 

E é isso! Sucesso!

Está com dúvidas?

Use o programa postman api para que simule todas as conexões e funcionalidades disponíveis para integração com o SIG Cloud.

Use a integração por GET, nele você encaminhará a Key gerada dentro da plataforma do SIG usando seu usuário e senha. Não deixe de conferir se seu SIG está habilitado para essa integração. Qualquer dúvida, pode conversar via chat.

Confira algumas dessas funcionalidades: Consulta cadastro cliente, envio para cadastro de cliente, consulta pedido, cadastro pedido, consulta produto, envio produto, consulta leads disponíveis, consulta leads, criação de leads, conversão de leads em clientes e muito mais.