Mudanças entre as edições de "Documentação API"

 
Linha 15: Linha 15:
  
 
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!'}''", deve-se entrar em contato através da [[Como utilizar o novo sistema de atendimento|plataforma de atendimento,]] selecionar o SAC - Suporte API e requisitar a viabilidade da inserção desse formulário, o mesmo vale para novos recursos especiais.
 
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!'}''", deve-se entrar em contato através da [[Como utilizar o novo sistema de atendimento|plataforma de atendimento,]] selecionar o SAC - Suporte API e requisitar a viabilidade da inserção desse formulário, o mesmo vale para novos recursos especiais.
 +
 +
=== API PHP ===
 +
No caso do consumo da API em PHP o IXC disponibiliza uma classe própria para requisições, a mesma pode ser encontrada na seguinte página [[PHP 2.0]].
  
 
-
 
-

Edição atual tal como às 15h06min de 29 de março de 2022

Antes de iniciar o desenvolvimento da aplicação, 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, conforme exemplificado na imagem abaixo:

2020-11-03 10-20.png

Para ajudar no desenvolvimento nós disponibilizamos exemplos de chamadas feitas em PHP, CURL, NODE, PYTHON e Postman. Abaixo temos um exemplo do CRUD feito em PHP.

2020-11-03 10-23.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

2020-11-03 10-28.png

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, como por exemplo: "Você não tem permissão". Se tiver duvidas sobre como gerenciar as permissões, confira através dessa wiki: Como alterar as permissões em cada grupo de usuário.

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!'}", deve-se entrar em contato através da plataforma de atendimento, selecionar o SAC - Suporte API e requisitar a viabilidade da inserção desse formulário, o mesmo vale para novos recursos especiais.

API PHP

No caso do consumo da API em PHP o IXC disponibiliza uma classe própria para requisições, a mesma pode ser encontrada na seguinte página PHP 2.0.

-