Como usar o Postman

Postman é uma plataforma API para construir e usar APIs. Vincular seu projeto Document360 ao Postman é fácil e pode ser concluído em poucos minutos. Você pode usar o Postman local ou online.

NOTA

Para mais informações sobre a aplicação do Carteiro, leia os artigos a seguir.

• Como baixar o aplicativo Postman?

• Como instalar e atualizar o aplicativo Postman?

• Como usar o Postman?

• Perguntas frequentes no Postman

Vinculando seu projeto Document360 no Postman

1. Os passos abaixo são baseados na aplicação do Carteiro no local.

2. Abra a inscrição do Carteiro.

3. Na seção Meu Espaço de Trabalho , clique no botão Importar .

   Um painel popup de Importação aparece.

4. Insira a URL abaixo no campo.
   https://apihub.document360.io/swagger/v2/swagger.json
   O pop-up Escolher como importar sua API aparecerá com duas opções.

5. Selecione a opção desejada

   • Coleção do Carteiro (padrão)

   • OpenAPI 3.0 com uma coleção Postman

6. Clique no botão Importar .

   Uma vez concluída a importação, a ação criará uma solicitação de exemplo para cada endpoint, permitindo que você faça a solicitação rapidamente.
   

   

Autenticação no Postman - Gerando um token API

1. Na visualização em árvore, expanda a API do Cliente do Document360.

2. Na aba Autorização, defina o Tipo de Auth para API Key a partir do menu suspenso.

3. Insira a variável desejada no campo Chave .

4. Insira o token API no campo Valor. Para gerar um token API, leia o artigo sobre Geração de token.

   NOTA

   Gerando um token API

   1. Navegue até Configurações () na barra de navegação à esquerda do portal da base de conhecimento.

   2. No painel de navegação à esquerda, navegue até o Portal da base de conhecimento > API Tokens.

   3. Crie o token de API desejado e copie o token.

   (ou) Copie o token de um token existente.

1. Na barra de navegação da esquerda, vá em Ambientes.

2. No painel de navegação à esquerda, clique em Criar Ambientes.

3. Na coluna Variables , digite o nome de uma variável, por exemplo, 'base_URL', e defina o Tipo como padrão.

4. Insira https://apihub.document360.io os campos INITIAL VALUE e CURRENT VALUE para a URL base.

5. Clique no botão Salvar .

   A autenticação do projeto foi concluída. Agora você pode acessar facilmente todos os endpoints disponíveis e realizar várias ações.

   

Casos de uso

Com a ajuda do Postman, você pode realizar várias ações no Document360.

Aqui estão alguns casos básicos de uso para sua referência

• Como criar e publicar um artigo?

• Como atualizar um artigo publicado?

• Como atualizar detalhes de SEO?

FAQ