Referência das ferramentas do Connector
Escolha a ferramenta e os parâmetros para trabalhar num Space.
Nesta página
Um Space é uma área de trabalho partilhada na app.
Encontre a ferramenta adequada e os respetivos parâmetros. Cada ferramenta de alojamento trabalha em exatamente um Space.
Nota
A aplicação está ligada à sua conta TEISENDA e a ligação não está terminada; saiba como em Claude e ChatGPT.
Para uma ferramenta de alojamento, a ligação aplica-se ao Space indicado na chamada. Pertence a esse Space e ele não está bloqueado.
A sua função no Space permite a ferramenta.
O argumento space determina o Space
Cada ferramenta de alojamento exige o argumento space: a Space-ID de dez dígitos. whoami não recebe argumentos.
A aplicação deve escolher o Space a partir de whoami ou da sua indicação e perguntar se houver vários Spaces possíveis.
Em cada chamada, a própria TEISENDA verifica se o Space pertence à ligação e se é membro. A ferramenta só é executada nesse Space.
Que valor aceita space?
Um número inteiro de dez dígitos ou texto com exatamente dez dígitos. A TEISENDA responde a qualquer outro valor como se faltasse um Space, por exemplo um número com menos ou mais dígitos. Para dez dígitos que não correspondem a um Space da ligação, responde que o Space não pertence à ligação. Ambas as mensagens estão na ferramenta de Spaces.
O resultado de uma ferramenta de alojamento começa pelo Space
O resultado começa pela Space-ID e pelo nome de apresentação. Verifique-os; se o Space estiver errado, a aplicação deve parar conforme as suas instruções.
Com Guardado, mas ainda não transferido para o nó de alojamento:, a alteração está guardada, mas ainda não foi transmitida. Verifique o estado mais tarde com hosting_project_status.
Quando é que um resultado não é um erro, apesar de ainda haver algo pendente?
Alguns resultados não estão assinalados como erro: a ferramenta fez o que podia e indica o que falta. Isto acontece se a versão indicada já estiver publicada, o DNS de um domínio ainda não estiver correto, um projeto tiver sido eliminado mas o nó de alojamento ainda não o tiver confirmado, ou na resposta de uma ferramenta de dois passos que pede a frase de confirmação.
O que altera uma ferramenta na TEISENDA e onde posso vê-lo?
Cada ferramenta chama os mesmos serviços que a interface da app, com as mesmas permissões e limites. As alterações na TEISENDA são iguais às que faria na interface.
O registo do projeto assinala as alterações com o canal Aplicação ligada quando a ação escreve uma entrada. As ferramentas de leitura não escrevem entradas aí. Ao escrever ou eliminar ficheiros, só regista a abertura de um novo rascunho.
A sua função permite a ferramenta
Proprietário, Administrador e Utilizador podem chamar todas as ferramentas de alojamento. Apenas leitura só podem utilizar cinco ferramentas de leitura; a lista está em Permissões.
A lista também mostra ferramentas que a sua função não permite. A permissão é verificada na chamada.
Nenhuma ferramenta de alojamento trabalha num Space bloqueado
whoami continua a listar um Space bloqueado e identifica-o como tal, mas nenhuma ferramenta de alojamento trabalha nele. Uma ligação cujos Spaces estejam todos bloqueados só disponibiliza whoami à aplicação. O que pode fazer está na ferramenta de Spaces; saiba mais sobre bloqueios em Compreender os Spaces.
As indicações dizem se uma ferramenta só lê ou altera dados
As indicações aparecem na ferramenta e na lista abaixo.
| Indicação | Significado |
|---|---|
| Só lê | A ferramenta não altera nada, não escreve nenhuma entrada de registo visível na app e pode ser repetida sem efeitos. Aplica-se a sete ferramentas de alojamento e a whoami. |
| Altera dados | A ferramenta altera algo. Aplica-se às restantes 16 ferramentas de alojamento. |
| Elimina, substitui ou altera o que é visível | A ferramenta elimina, substitui ou altera o que os visitantes de um website veem. A indicação não significa que elimina; a respetiva secção explica a ação. |
| Dois passos | A ferramenta exige uma frase de confirmação. |
Três ferramentas exigem uma frase de confirmação
hosting_delete_project, hosting_remove_domain e a mudança para público com hosting_set_visibility trabalham em dois passos: sem confirm, a resposta indica a consequência e a frase; só uma chamada com essa frase executa a ação.
A aplicação deve obter primeiro o seu consentimento. Verifique o projeto e o Space; as permissões explicam o procedimento.
Atenção
Todas as outras ferramentas executam na primeira chamada, incluindo ao eliminar, substituir ou alterar o website. Não está garantida uma confirmação pela aplicação.
As ferramentas utilizam alguns termos diferentes desta documentação
As descrições das ferramentas estão em inglês. As respostas em alemão utilizam alguns termos diferentes desta documentação.
| Nas respostas em alemão | Nesta documentação |
|---|---|
«Stand», «Deployment»; como parâmetro deploy |
Versão. As ferramentas também dão este nome ao rascunho. |
«Deployment», quando o plano conta; como campo deployments |
Publicação: publicar uma versão pela primeira vez utiliza uma. Voltar a publicar uma versão anteriormente publicada não utiliza nenhuma. |
| «offener Stand» | Rascunho: os ficheiros ainda podem ser alterados e não está publicado. Um projeto tem, no máximo, um. |
| «abgeschlossen» | Versão concluída: qualquer versão verificada que já não pode ser alterada, publicada ou não. |
| «fertig, aber nicht veröffentlicht» | Versão pronta: uma versão concluída que nunca foi publicada. |
| «automatic address» nas descrições das ferramentas | Endereço TEISENDA: o endereço atribuído pela TEISENDA ao projeto. |
Cada ferramenta tem uma secção numa subpágina
O nome abre a secção da ferramenta com os seus parâmetros. Os títulos estão em inglês.
| Ferramenta | Título | Propriedades |
|---|---|---|
whoami | Show user and spaces | apenas lê |
hosting_list_projects | List projects | apenas lê |
hosting_create_project | Create project | altera dados |
hosting_project_status | Project status | apenas lê |
hosting_rename_project | Rename project | altera dados |
hosting_set_offline | Take project offline or online | altera dadoselimina, substitui ou altera o que é visível |
hosting_delete_project | Delete project | altera dadoselimina, substitui ou altera o que é visíveldois passos |
hosting_put_files | Write files | altera dadoselimina, substitui ou altera o que é visível |
hosting_delete_files | Delete files | altera dadoselimina, substitui ou altera o que é visível |
hosting_list_files | List files | apenas lê |
hosting_read_file | Read file | apenas lê |
hosting_create_upload | Create upload link | altera dadoselimina, substitui ou altera o que é visível |
hosting_deploy | Publish deployment | altera dadoselimina, substitui ou altera o que é visível |
hosting_deploy_status | Deployment status | altera dadoselimina, substitui ou altera o que é visível |
hosting_list_deploys | List deployments | apenas lê |
hosting_rollback | Roll back deployment | altera dadoselimina, substitui ou altera o que é visível |
hosting_add_domain | Add domain | altera dados |
hosting_check_domain | Check domain | altera dados |
hosting_set_primary_domain | Set primary domain | altera dadoselimina, substitui ou altera o que é visível |
hosting_remove_domain | Remove domain | altera dadoselimina, substitui ou altera o que é visíveldois passos |
hosting_get_visibility | Get visibility | apenas lê |
hosting_set_visibility | Set visibility | altera dadoselimina, substitui ou altera o que é visíveldois passos |
hosting_list_redirects | List redirects | apenas lê |
hosting_set_redirects | Set redirects | altera dadoselimina, substitui ou altera o que é visível |
Alguns limites e mensagens aplicam-se a todas as chamadas
Uma chamada dura no máximo dois minutos; um pedido tem no máximo 8 MB. Os restantes limites e a ajuda para resolver problemas aplicam-se a todas as ferramentas.
Os limites do plano do Space estão nas ferramentas de projetos, domínios, ficheiros e publicação; os planos estão em Planos Free e Max.