Konviva | Integração via Webservice
Este documento descreve o processo de integração padrão do Konviva via Webservices com os sistemas utilizados pelo cliente.
Trata-se de uma atividade realizada sob demanda, dentro do padrão pré-definido pela Konviva, para clientes que possuem este serviço contratado.
Caso os padrões oferecidos pela Konviva não atendam as necessidades do cliente, a Konviva analisará a viabilidade de adequação serviços.
Nas integrações via Webservice a Konviva disponibilizará serviços no padrão REST/JSON, na qual haverá operações de exportações e importações.
No caso das exportações, serão disponibilizados serviços de consulta a serem chamados pelo sistema do cliente.
Já as importações, serão disponibilizados serviços de inserção, atualização e exclusão de dados.
Todos os terminais de API do Konviva suportam múltiplas ações.
Cada ação é definida pelo método HTTP.
Esses métodos geralmente seguem as orientações abaixo:
Método |
Descrição |
Exemplo |
| GET | Lê dados | GET/usuário/1 (este exemplo retorna os dados do usuário 1) |
| POST | Adiciona novos recursos para uma conexão. Este Método requer, geralmente, parâmetros adicionais. | POST/IntegrarUnidade (este exemplo cadastra a unidade). |
| PUT | Altera recursos existentes ou conecta dois recursos juntos. | PUT/IntegrarUnidade (este exemplo altera a unidade). |
| DELETE | Apaga dados existentes. | DELETE/integrarUnidade (este exemplo deleta a unidade). |
Para autenticar a requisição, é necessário inserir um cabeçalho HTTP Authorization" conforme o exemplo a seguir:
Authorization KONVIVA <token>
O TOKEN é único para cada cliente e este será disponibilizado durante a implantação.
É possível encontrar a documentação detalhada através da url_do_konviva/api_doc/ Exemplo: http://academiailog.konviva.com.br/api_doc/