Para uma melhor interpretação de Simple API, mostramos quantos pedidos são contabilizados tomando como base os exemplos de JSON disponibilizados no HelpCenter 1:
| Methods |
Nº Pedidos API |
| createCustomer |
4 |
| create_updateCustomer |
4 |
| createProduct |
6 |
| create_updateProduct |
6 |
| createDocument |
- 0 - Send document by email
- 1 - Return document pdf link to print
- 2 - Create document without signing
- 3 - Create document with signing but does not produce pdf and email with pdf for client
|
12
12
8
10 |
| createPurchase |
- 0 - Send document by email
- 1 - Return document pdf link to print
|
13
13 |
| createInternalDocument |
- 0 - Send document by email
- 1 - Return document pdf link to print
|
10
10 |
| createReceipt |
- 0 - Send document by email
- 1 - Return document pdf link to print
- 2 - Create document without signing
- 3 - Create document with signing but does not produce pdf and email with pdf for client
|
7
6
4
6 |
| createAdvancesCl |
- 0 - Send document by email
- 1 - Return document pdf link to print
- 2 - Create document without signing
- 3 - Create document with signing but does not produce pdf and email with pdf for client
|
11
11
11
9 |
| createAdvancesFl |
- 0 - Send document by email
- 1 - Return document pdf link to print
- 2 - Create document without signing
- 3 - Create document with signing but does not produce pdf and email with pdf for client
|
10
10
10
8 |
| createPartialReceipt |
- 0 - Send document by email
- 1 - Return document pdf link to print
|
10
9 |
| createAvenca |
12 |
| cancelDocument |
4 |
| cancelInternalDocument |
3 |
| cancelAdvances |
4 |
| cancelReceipt |
2 |
| annulReceipt |
4 |
| updateCompany |
3 |
| runAnalysis |
- 0 - Return the analysis values as JSON
- 1 - Return the analysis as XLSX file
|
0
0 |
| fetchRecords |
1 |
| fetchFilteredRecords |
1 |
| fetchDocument |
4 |
| searchEntities |
2 |
| saveInstance |
4 |
1 O número de pedidos pode variar consoante o número de querys que são feitas à base de dados, ou seja, são contabilizados pedidos quando a query é feita por exemplo à tabela Moeda, Motivos de Isenção de Imposto, País...
sticky_note_2Notas
Sempre que efetuar chamadas utilizando a Simple API, será sempre consumido uma licença de utilizador
(ou seja, caso tenha subscrito ao plano Advanced do PHC GO, é possível ter sessão iniciada com 3 utilizadores, além do utilizador associado à chamada).
tips_and_updatesDicas
No portal
DevGO, está disponível para utilização o
Simulador de Consumo de pedidos API, através do qual pode simular o número de pedidos necessários em cada método da Simple API.
infoInformação
Ao usar uma taxa isenta com o respetivo motivo de isenção de imposto, por exemplo num produto ou até na linha do documento de faturação, vai gastar mais um pedido para cada artigo que se encontre nessas condições.
Os pedidos que retornem erros também são contabilizados consoante o método usado.
sticky_note_2Notas
Disponível brevemente
Ao alcançar o limite mensal de pedidos de API durante uma operação, esta é concluída integralmente, sem interrupções. Concede-se aos usuários a capacidade de encerrar a operação de forma controlada, assegurando uma transição suave e evitando documentos incompletos.
infoInformação
Sobre o ecrã das Análises e Listagens, o utilizador dispõe da Análise de pedidos de API que permite verificar os pedidos realizados, por meio da API, em função do ano e mês em questão.
São apresentados os serviços utilizados, os métodos e o número de pedidos em um determinado período de tempo.
Quando o consumo de pedidos ultrapassar os 75%, ao entrar aplicação, os utilizadores configurados como Administrador do Sistema são notificados dessa situação sobre a área das "Notificações".
É enviado também um e-mail a todos os utilizadores existentes na aplicação, configurados como Administrador do Sistema, informando desta situação de percentagem de consumo.
Após atingir os 100%, o utilizador também é notificado via e-mail e no próprio software sobre a área das "Notificações".
Estas notificações contêm um link para a store onde poderá adquirir pacotes extra de pedidos à API. No caso da notificação do tipo aviso no software basta clicar em -> Navegue. No e-mail recebido com o alerta, pode aceder à store para adquirir pacotes extra de pedidos à API clicando em -> Compre mais aqui.