Documentação API

Antes de iniciar o desenvolvimento, verifique se foi realizado o procedimento descrito no tópico Configurando acesso ao Webservice API.

A API é baseada nos formulários do IXCSoft, a documentação deses formulários e seus respectivos campos está disponível no link https://www.ixcsoft.com.br/wiki_api/provedor .

No menu da esquerda temos os fomulários agrupados por tipo.

Exemplo de formulário api.png

Para ajudar no desenvolvimento nós disponibilizamos exemplos de código na documentação, como pode ser visto abaixo:

Exemplo da documentação da API.png

E também a respeito dos tipos dos campos, lembrando que em caso de inserção, podem ocorrer erros, caso o tipo não esteja de acordo.

Exemplo de tipo de campo api.png

Alem dos formulários e campos, também existe a possibilidade de usar um recurso especial, como por exemplo Desbloqueio de Confiança - API.

Consumindo a API

A API pode ser consumida de qualquer linguagem programação que consiga realizar uma requisição para Web e receber o retorno da mesma.

O retorno normalmente será do tipo json de acordo com os dados solicitados. Vale lembrar que a API respeita a configuração de permissões do IXCSoft, normalmente uma mensagem será retornada "Você não tem permissão". Se tiver duvidas sobre como gerenciar as permissões, veja aqui: Como alterar as permissões em cada grupo de usuário, ou em vídeo: https://www.youtube.com/watch?v=oqq5Ouc390M&t=10s, https://www.youtube.com/watch?v=Y0kWRrTixik&t=1524s.

Os principais formulários estão disponíveis para listar, editar, excluir e inserir ou usar um recurso especial. Caso ao consumir API, se depare com a mensagem " { type: 'error', message: 'Recurso nome_formulário não está disponível!' }", o procedimento será chamar o suporte pela plataforma de atendimento, selecionar o SAC do suporte Geral e requisitar a viabilidade da inserção desse formulário, o mesmo vale para novos recursos especiais.

Para facilitar ainda mais, desenvolvemos alguns exemplos de API cliente, que podem ser usados como exemplo para o desenvolvimento.

API Cliente