Administração da API

Onde faço a gestão das minhas APIs?

Todas as interfaces são geridas no Portal BulkGate, em Módulos e APIs. O ecrã tem duas partes:

Minhas APIs e módulos — cartões das interfaces que já criou. Clique num cartão para abrir o respetivo detalhe.
Descubra nossas APIs e módulos — o catálogo de tudo o que pode configurar. Ao clicar num mosaico, abre-se uma janela com a descrição, ligações para Local na rede Internet e Documentação e o formulário de criação.

O ecrã Módulos e APIs com as partes Minhas APIs e módulos e Descubra nossas APIs e módulos

Como crio uma nova API?

No menu, clique em Módulos e APIs
Em Descubra nossas APIs e módulos, clique no mosaico da interface que pretende configurar
Preencha o formulário na janela que se abre
Clique em Criar API

A janela com o formulário para criar uma HTTP Simple API

O formulário varia consoante o tipo de interface:

Tipo	Campos do formulário
APIs HTTP e módulos baseados em token	`Nome` e `Máximo de mensagens de API por dia`
`Email > SMS` e Low Level API	`Carteira` e `Nome`
Módulos para transferir	sem formulário, apenas o botão `Obter módulo`

Nota

Nas APIs HTTP, o campo Máximo de mensagens de API por dia é obrigatório — enquanto não o preencher, o botão Criar API permanece desativado.

Depois de criar a interface, é encaminhado para o respetivo detalhe. No caso de Email > SMS, a parte Configurações de email contém os dados para onde envia: Destinatário, Assunto curto de SMS e Assunto longo de SMS.

O que é o Application ID?

O Application ID (APPLICATION_ID) é o número único da sua aplicação. Juntamente com o Application token (APPLICATION_TOKEN), forma as credenciais de acesso à API.

No detalhe da aplicação, encontra-se logo abaixo do nome da aplicação, no formato #39238, e novamente na parte Credenciais de login.

Onde encontro as credenciais de acesso?

No menu, clique em Módulos e APIs
Em Minhas APIs e módulos, clique no cartão da sua aplicação
Mantenha-se no separador Definições e procure a parte Credenciais de login

A parte Credenciais de login do detalhe da aplicação com o Application ID e o token

Contém o Application ID e a lista de tokens. Por motivos de segurança, o token não é apresentado de imediato — solicita-o com Mostrar token e confirma com a sua palavra-passe. Adicionar token e Regenerar token estão protegidos da mesma forma. Os pormenores são explicados na página Tokens de API.

Como ativo ou desativo uma API?

Abra o detalhe da aplicação
Por baixo do nome da aplicação encontra-se um botão com o estado atual — Ativo ou Desabilitado
Expanda-o e escolha Habilitar ou Desabilitar
Confirme na janela Mudar o status

Aviso

Uma API desativada rejeita todos os pedidos. Uma API ativa aceita todos os pedidos.

Como mudo o nome ou elimino uma API?

No canto superior direito do detalhe encontra-se o botão Renomear. Abre uma janela com o campo Nome; confirma a alteração novamente com Renomear.

A seta ao lado expande um menu com a opção Excluir.

Cuidado

A eliminação de uma aplicação não pode ser anulada e remove também todos os tokens que lhe pertencem.

Como configuro os relatórios de entrega?

No separador Definições, o detalhe da aplicação contém a parte Web hooks com o cartão Relatórios de entrega. Aí indica o endereço para o qual o BulkGate comunica o estado das mensagens enviadas e entrega as respostas recebidas.

Todo o procedimento e todas as opções estão descritos na página Webhooks.

Esta página foi útil?

Perguntar à IA Copiado