Guia dos Ambientes Hiperstream

A Hiperstream oferece ambientes distintos para testes e produção, permitindo aos desenvolvedores integrar e testar suas soluções com segurança antes de lançá-las em um ambiente produtivo. Este guia resume os ambientes disponibilizados pela Hiper e como utilizá-los.

📘 Para mais informações sobre autenticação, consulte Segurança.

Estrutura de Endpoint

Um endpoint é uma URL utilizada para enviar uma solicitação à plataforma HiperStream. Os endpoints seguem a seguinte sintaxe:

protocolo:hostname/[prefixo]/versão_da_API/caminho

Aqui está um exemplo de endpoint que direciona uma solicitação para o ambiente de testes (sandbox) da HiperStream:

https://sandbox-api.hiperstream.com/communications/v1/send/

A tabela a seguir explica os diferentes componentes no exemplo de endpoint:

Nome	Componente	Detalhes
protocolo	https://	Sempre https://. Isso significa que a conexão é criptografada e seus dados estão seguros.
hostname	sandbox-api.hiperstream.com	Nome do servidor que identifica o ambiente.
prefixo	communications	Nome do serviço que está sendo acessado.
versão da API	v1	Versão da API usada pelo endpoint. Usada para evitar alterações que quebrem paths existentes.
caminho	send	Caminho do endpoint que especifica o método chamado pelo endpoint. Segue o padrão REST API.

Ambientes fornecidos pela HiperStream

Atualmente, a Hiper fornece os seguintes ambientes:

Sandbox – Um ambiente estável destinado a desenvolvedores externos que desejam testar suas integrações. Nada feito no Sandbox afeta dados reais.
Produção – Usado pelo usuário final para interagir com a plataforma HiperStream. Qualquer mudança aqui pode afetar dados de produção ao vivo.

O endpoint utilizado determina o ambiente para o qual sua chamada é roteada, portanto, cada tipo de solicitação possui múltiplos endpoints associados a ele, dependendo do ambiente alvo. Por exemplo, se você enviar uma solicitação para o ambiente de testes, precisará usar um endpoint diferente para enviar a mesma solicitação para a produção.

Componentes de um Ambiente Hiperstream

Cada ambiente HiperStream consiste exatamente nos mesmos componentes. Se você entender alguns conceitos centrais, deverá ser capaz de identificar problemas independentemente de onde os encontrar..

Hostnames

Um hostname é o ponto de entrada para um ambiente. Cada ambiente tem seu próprio servidor:

Sandbox – Servidor que lida com a maioria das chamadas de API para testes e desenvolvimento.
Produção – Servidor que lida com todas as operações em ambiente produtivo.

No ambiente de produção, a Hiperstream fornece hostnames específicos baseados nas necessidades de implementação do cliente. Entre em contato com o time de Professional Services da Hiperstream através do portal de atendimento e solicite ao seu os hostnames a serem usados em produção.