Visão Geral da funcionalidade

WebAPI é um recurso que permite o mapeamento e utilização de webservices REST, que tenham definição SWAGGER transformando o mapeamento em uma nova API disponível para utilização nos Workflows do S-Works.

Configuração de uma WebApi

1. Clique em Administração > Web APIs.

2. Clique em Adicionar Web API. 

No Formulário Web API de configuração existe a opção de utilizar a URL de definição do SWAGGER para coletar os detalhes do webservice (passo a passo abaixo).

1. Informe o Tipo (ou padrão) de autenticação. Atualmente existem três opções:

3. Padrão IWT (Inter Web Token);
4. Padrão FWT (FrontBank Web Token); ou 
5. Sem autenticação.

2. Informe a Definição/URL da WebApi utilizando o recurso SWAGGER ou cole a definição do webservice na notação JSON.

1. Notação JSON: O S-Works não suporta notação que esteja no padrão superior a 2.0

No anexo deste documento segue um modelo de notação JSON.

5. Informe a URL Autenticação.
6. Informe a Conta Autenticação configurada com o usuário/senha que será utilizada na autenticação.
7. Clique em Atualizar para o sistema acessar as definições do Web Service e preencher as informações. 

7. Informe a URL do WebService.
8. Informe o Nome da API. Este será o nome da API ao configurar uma tarefa no S-Works.

A API será visualizada com o nome configurado no passo anterior. Exemplo abaixo:

Configuração autenticação da API

1. Clique em Administração > Autenticação de APIs.

2. 
   

3. Clique em Adicionar.

Realize as configurações necessárias no Formulário de Cadastro: 

4. Informe o Nome da autenticação; 
5. Informe a Descrição da autenticação (opcional);
6. Informe a Empresa que utilizará essa autenticação;
7. Informe o Tipo de autenticação:

1. BasicAuthorization

Essa autenticação será enviada no cabeçalho da requisição passando o usuário e senha que está cadastrado na conta que foi configurada para essa ação.

2. Oauth2ClientCredentials ou Oauth2Password

2. OAuth2ClientCredentials: Autenticação com OAuth 2.0 do tipo concessão por client credentials.
3. OAuth2Password: autenticação com OAuth 2.0 do tipo concessão por password.

Ambos são para realizar a autenticação e obtenção de token. O que difere é o tipo de concessão que será usada para obtenção desse token.

5. Informe URL de autenticação;

6. Informe o Scope: O escopo é um mecanismo do OAuth 2.0 para limitar o acesso de um aplicativo à conta de um usuário, ou seja, se necessário será preenchido um ou mais valores de escopo indicando quais recursos do usuário você deseja obter acesso (Opcional);
7. Informe conta id/secret: o id ou o secret atribuído ao aplicativo. É possível localizar essas informações no portal onde foi registrado o aplicativo (Opcional); 
8. Informe credenciais no header, ou seja, se as credenciais serão passadas no cabeçalho (Opcional);
9. Informe a conta;
10. Informe o envio do token:

1. Opção Padrão: o token será enviado tanto no “x-api-token” quanto no “Authorization”;
2. Opção x-api-token: O token será enviado somente no x-api-token;
3. Opção Authorization: O token será enviado somente no authorization.

Anexo

swagger: '2.0'

info:

 title: API.FormalizacaoSworks

 version: v1

host: mb-api-formalizacaosworks-creditohml.com.br

schemes:

 - http

paths:

 '/api/Propostas/NumeroOperacao/{numeroOperacao}/Formalizacao':

   put:

     tags:

       - Propostas

     summary: Retorno formalização sworks.

     consumes:

       - application/json

       - text/json

       - application/*+json

     produces:

       - text/plain

       - application/json

       - text/json

     parameters:

       - in: path

         name: numeroOperacao

         description: Identificador da proposta.

         required: true

         type: integer

         format: int32

       - in: body

         name: body

         description: Detalhes da formalização.

         schema:

           $ref: '#/definitions/RetornoFormalizacaoSworksPost'

     responses:

       '200':

         description: Retorno formalização recebido com sucesso.

       '400':

         description: Parametros incorretos.

         schema:

           $ref: '#/definitions/CoreExceptionDto'

       '500':

         description: Erro interno.

definitions:

 StatusFormalizacaoDto:

   format: int32

   enum:

     - 1

     - 2

     - 3

   type: integer

 TipoDocumentoDto:

   format: int32

   enum:

     - 1

     - 2

     - 3

   type: integer

 DocumentoDto:

   type: object

   properties:

     nome:

       description: Nome do arquivo

       type: string

     extensao:

       description: Extensão do arquivo

       type: string

     conteudoArquivo:

       format: byte

       description: Conteúdo do arquivo

       type: string

     tipoDocumento:

       $ref: '#/definitions/TipoDocumentoDto'

 RetornoFormalizacaoSworksPost:

   type: object

   properties:

     processoId:

       format: uuid

       description: Identificador do processo

       type: string

     status:

       $ref: '#/definitions/StatusFormalizacaoDto'

     observacao:

       description: Observação sobre a formalização

       type: string

     documentos:

       description: Detalhes dos documentos

       type: array

       items:

         $ref: '#/definitions/DocumentoDto'

     cpfCliente:

       format: int64

       description: Cpf do cliente

       type: integer

 SworksError:

   type: object

   properties:

     key:

       type: string

     message:

       type: string

 CoreExceptionDto:

   type: object

   properties:

     key:

       type: string

     errors:

       type: array

       items:

         $ref: '#/definitions/SworksError'