Crie integrações com a API da AlwaysCompleted

Conecte a AlwaysCompleted ao seu fluxo de trabalho no servidor para consultar serviços, criar pedidos e acompanhar o andamento deles. Este guia apresenta desde a primeira requisição somente de leitura até as verificações importantes ao criar pedidos. Mantenha a documentação de referência da API aberta para consultar as listas completas de parâmetros e os exemplos de resposta.

Prepare a conexão

1. Crie uma conta e use a chave de API da sua conta na configuração do servidor.
2. Consulte o catálogo de serviços e as condições dos serviços que pretende oferecer. Os requisitos, as opções disponíveis e os limites dos pedidos dependem do serviço selecionado.
3. Envie as requisições a partir do seu próprio backend por HTTPS. Mantenha a verificação padrão de certificados TLS ativada.
4. Armazene a chave de API com segurança no servidor. Não a inclua em páginas públicas, JavaScript executado no navegador, capturas de tela ou exemplos de código compartilhados.

Faça a primeira requisição somente de leitura

O endpoint documentado aceita requisições POST e retorna JSON. O exemplo oficial de requisição usa parâmetros de formulário codificados em URL. Toda ação inclui sua chave de API e o nome da ação.

POST https://alwayscompleted.com/api/v2

key=YOUR_API_KEY&action=services

Substitua o valor de exemplo apenas na configuração do servidor. A ação services consulta o catálogo; ela não cria um pedido. Use a resposta para identificar os IDs dos serviços e examinar os campos disponíveis antes de criar seu formulário de pedido.

Use informações atuais sobre os serviços e a conta

A lista de serviços informa o nome, o tipo, a categoria, o preço, a quantidade mínima e máxima de cada serviço, além dos indicadores de reposição e cancelamento. Confira a descrição e os requisitos atuais do serviço correspondente ao ID escolhido. Use os dados retornados ao preparar um pedido, em vez de copiar IDs ou preços ilustrativos dos exemplos da documentação.

Use action=balance para consultar o saldo da conta e sua moeda. Os valores dos exemplos na documentação são apenas ilustrativos. Seu aplicativo deve exibir a resposta real e tratar os erros antes de prosseguir.

Crie pedidos com cuidado

Para criar um pedido, envie action=add com o ID do serviço selecionado e os campos exigidos para esse tipo de serviço. Um pedido do tipo Default usa link e quantity; outros tipos têm parâmetros diferentes. Consulte a seção correspondente da documentação antes de enviar.

Quando a criação for concluída com sucesso, salve o ID do pedido retornado junto ao registro do pedido no seu sistema. Se uma requisição exceder o tempo limite ou a resposta não for clara, verifique o resultado antes de enviá-la novamente. Repetir uma requisição add sem verificar o resultado pode criar um pedido duplicado involuntário. Nunca use a criação de pedidos como teste automático de conexão.

Acompanhe os pedidos e as solicitações posteriores disponíveis

Use action=status com order para consultar um pedido, ou orders com IDs separados por vírgulas para um lote de até 100. A resposta documentada inclui status, charge, start_count, remains e currency. Examine cada resultado: um lote pode conter um erro para um ID específico.

Reposição e cancelamento são solicitações sujeitas à disponibilidade e às condições do serviço selecionado. Use action=refill para solicitar uma reposição, action=refill_status para acompanhá-la e action=cancel para solicitar o cancelamento. As versões em lote documentadas aceitam até 100 IDs. O envio de uma solicitação não garante a aprovação da reposição ou do cancelamento.

Continue sua integração

Consulte a documentação completa da API para conhecer os parâmetros exatos de cada ação e os exemplos. Se estiver criando um fluxo de serviços para seus clientes, consulte AlwaysCompleted para revendedores. Leia os Termos e políticas junto com a descrição de cada serviço antes de aceitar pedidos de clientes.