Guia de Conexão de Vinyl API SOAP 2.6¶

Visão Geral¶

Este guia descreve os requisitos do sistema e instruções para conectar o Vinyl a uma API SOAP e endpoint.

Para conectar seus servidores, você deve ter o Vinyl 2.6 instalado.

Requisitos de Sistema¶

Servidor de Serviços Web¶

API SOAP

Navegador da Web do Cliente¶

• Chrome TM 60 ou mais recente

• Firefox 55 ou mais recente

• Safari 11.0.2 ou mais recente

Instruções de Conexão¶

Adicionando um Servidor¶

1. Navegue até Vinyl IDE

2. No menu Conectar, clique no link Conectar-se à sua empresa

3. Clique no botão Criar no canto superior esquerdo do painel Servidores de Dados. Isso abrirá a página Adicionar Servidor.

   • Nome do Servidor: Nome identificável para conexão do servidor Tipo: API REST

   • Subtipo: SOAP

   • Url: URL associada à API SOAP

   • Tipo de conteúdo da solicitação: XML

   • Tipo de conteúdo de resposta: XML

   

4. Clique em Salvar para concluir a conexão do servidor.

5. Clique em Testar conexão para garantir que a conexão funcione corretamente.

Configuração de Endpoint¶

1. Clique no Nome do Servidor da conexão SOAP API que você acabou de fazer

2. No painel Endpoints, clique em Criar

3. Adicione os seguintes dados:

   • Nome: nome identificável para endpoint Endpoint: segmento de URL específico para endpoint

   • Método: Um dos métodos da API, ou seja, POST, GET, PUT, DELETE, PATCH

   • Exemplo de entrada: cópia direta do corpo xml do endpoint da API desejado, com variáveis inseridas {{}} para passar parâmetros de Endpoint

   • Url de teste: URL completo da API e endpoint

   

4. No painel Parâmetros de Endpoint, clique em Criar para criar parâmetros que correspondam ao que foi colocado {{}} na etapa anterior. É aqui que você pode inserir credenciais, como API-KEY ou consultas de URL.

5. Clique em Salvar para concluir a inserção do parâmetro do endpoint

6. Clique em Testar conexão para garantir que o endpoint esteja configurado corretamente.

7. Clique em Importar para concluir a configuração do endpoint