Carteiro

Nossas APIs podem ser utilizadas com qualquer cliente HTTP; no entanto, recomendamos Carteiro, uma interface gráfica intuitiva para um poderoso cliente HTTP multiplataforma.

A Vonage criou uma coleção no Postman, projetada para facilitar o início rápido com nossas APIs mais utilizadas. O espaço de trabalho está organizado por funcionalidade, permitindo que você encontre facilmente a API que está procurando. Ele também contém solicitações totalmente documentadas; na aba “Descrição” de cada solicitação, você encontrará documentação explicando o que a chamada faz, quando usá-la, as variáveis necessárias (chaves de API, segredos, JWTs) e as respostas esperadas.

Clique no botão “Executar no Postman” para criar um fork do espaço de trabalho em seu próprio ambiente do Postman e testar a coleção:

Você também pode baixar e importar nossas especificações OpenAPI diretamente, seguindo as instruções abaixo.

Postman e OpenAPI

O Postman oferece suporte aos documentos OpenAPI que publicamos junto com todas as nossas APIs.

Instale o Postman e siga as etapas descritas abaixo para testar rapidamente qualquer uma das APIs da Vonage. Publicamos um documento OpenAPI para cada API, e o Postman pode lê-los e criar uma coleção de solicitações nas quais você pode inserir valores.

Baixar e importar a especificação OpenAPI

A maneira mais fácil de encontrar o documento OpenAPI é clicar no botão “Baixar a especificação OpenAPI 3” na página de referência da API que você deseja experimentar. Por exemplo, acesse a Página de referência da API do Verify e clique no botão de download. Você pode baixá-lo em .yml ou .json formato.

Você pode então seguir estas instruções para importar o arquivo para o Postman.

Fazer uma chamada de API

Após a importação, você poderá ver os diferentes endpoints disponíveis para a API. Por exemplo, se você importou a descrição da API Verify, poderá selecionar “Solicitar o envio de uma verificação a um usuário” no menu de navegação à esquerda e obter uma solicitação pronta para uso. Depois de atualizar os cabeçalhos e o corpo da solicitação com as informações necessárias, você pode clicar em “Enviar” e verificar a resposta da API.

Uso avançado do Postman

Ambientes de uso

O Postman possui um característica dos ambientes que permite que você use as mesmas variáveis (como suas credenciais de API) em várias solicitações diferentes.

Para criar um ambiente, clique na engrenagem de configurações no canto superior direito da tela e selecione “Adicionar”. Dê um nome ao seu ambiente e adicione as variáveis que desejar usar, como, por exemplo:

• api_key
• api_secret
• phone_number

Depois de salvar, você pode, por exemplo, inserir {{api_key}} em suas solicitações, em vez de colar sua chave de API. O Postman utilizará o valor do ambiente atual.

Você pode ter vários ambientes, o que é útil se você usar chaves diferentes para finalidades distintas ou se estiver enviando solicitações de API para uma ferramenta de depuração ou um servidor de simulação de API, como o Prism. Adicione quantos ambientes forem necessários, repetindo as etapas acima e selecionando o ambiente a ser usado no menu suspenso localizado no canto superior direito da tela.

Coleções do Postman

Para obter informações sobre as coleções do Postman, consulte o Coleções do Postman documentação.