Partilhar via

Carteiro (Editora Independente) (Pré-visualização)

Postman é uma plataforma para construir e usar APIs. O Postman simplifica cada etapa do ciclo de vida da API e agiliza a colaboração.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Fördős András
Email fordosa90+mipc@gmail.com
Metadados do conector
Editora Fördős András
Sítio Web https://www.postman.com/
Política de privacidade https://www.postman.com/legal/privacy-policy/
Categorias Operações de TI; Produtividade

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API securestring Chave de API pessoal para autenticação. Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Criar um espaço de trabalho

Cria um novo espaço de trabalho para o usuário autenticado.
Importar OpenAPI

Importe uma definição OpenAPI (ou swagger) para seu espaço de trabalho.
Listar todas as coleções

Liste todas as suas coleções inscritas.
Listar todos os ambientes

Obtenha informações sobre todos os seus ambientes.
Listar todos os espaços de trabalho

Liste todos os espaços de trabalho disponíveis para o usuário autenticado.
Obter ambiente

Obtém informações sobre um ambiente específico.
Obter coleção

Obtém informações sobre uma coleção específica de carteiros.
Obter espaço de trabalho

Obtém informações sobre um espaço de trabalho específico.
Obter usuário autenticado

Obtém informações e detalhes de uso sobre o usuário autenticado.

Criar um espaço de trabalho

ID da Operação:
CreateAWorkspace

Cria um novo espaço de trabalho para o usuário autenticado.

Parâmetros

Name Chave Necessário Tipo Description
Nome
 name True string

Nome do espaço de trabalho.
Description
 description string

Descrição do espaço de trabalho.
Tipo
 type True string

Tipo de espaço de trabalho, por exemplo, "pessoal"

Devoluções

Name Caminho Tipo Description
Id
 workspace.id string

Identificador exclusivo do espaço de trabalho.
Nome
 workspace.name string

Nome do espaço de trabalho.

Importar OpenAPI

ID da Operação:
ImportOpenApi

Importe uma definição OpenAPI (ou swagger) para seu espaço de trabalho.

Parâmetros

Name Chave Necessário Tipo Description
ID do espaço de trabalho
 workspace string

Valor opcional, definindo o ID do espaço de trabalho para o qual importar.

Devoluções

Name Caminho Tipo Description
collections
 collections array of object
Id
 collections.id string

Identificador da coleção.
Nome
 collections.name string

Nome da coleção.
UID
 collections.uid string

Identificador único global da coleção.

Listar todas as coleções

ID da Operação:
ListCollections

Liste todas as suas coleções inscritas.

Parâmetros

Name Chave Necessário Tipo Description
ID do espaço de trabalho
 workspace string

Valor opcional, definindo o ID do espaço de trabalho para verificar se há coleções.

Devoluções

Name Caminho Tipo Description
Collections
 collections array of object

Matriz de coleções.
Id
 collections.id string

Identificador da coleção.
Nome
 collections.name string

Nome da coleção.
Proprietário
 collections.owner string

Identificador exclusivo do proprietário da coleção.
Criado em
 collections.createdAt string

Carimbo de data/hora indicando a criação da coleção, em formato UTC.
Atualizado em
 collections.updatedAt string

Timestampt, indicando a última atualização da coleção, em formato UTC.
UID
 collections.uid string

Identificador global exclusivo da coleção.
É público
 collections.isPublic boolean

Booleano indicando, se a coleção é pública.

Listar todos os ambientes

ID da Operação:
ListEnvironments

Obtenha informações sobre todos os seus ambientes.

Parâmetros

Name Chave Necessário Tipo Description
ID do espaço de trabalho
 workspace string

Valor opcional, definindo o ID do espaço de trabalho para verificar os ambientes.

Devoluções

Name Caminho Tipo Description
Environments
 environments array of object

Variedade de ambientes.
Id
 environments.id string

Identificador do ambiente.
Nome
 environments.name string

Nome do ambiente.
Criado em
 environments.createdAt string

Carimbo de data/hora quando o ambiente foi criado, no formato UTC.
Atualizado em
 environments.updatedAt string

Carimbo de data/hora quando o ambiente foi atualizado pela última vez, no formato UTC.
Proprietário
 environments.owner string

Identificador do usuário proprietário do ambiente.
UID
 environments.uid string

Identificador global exclusivo do ambiente.
É público
 environments.isPublic boolean

Booleano indicando, se o ambiente é público ou não.

Listar todos os espaços de trabalho

ID da Operação:
ListWorkspaces

Liste todos os espaços de trabalho disponíveis para o usuário autenticado.

Parâmetros

Name Chave Necessário Tipo Description
Tipo
 type string

Opcional, defina o tipo de espaço de trabalho a ser retornado, por exemplo, 'pessoal'.

Devoluções

Name Caminho Tipo Description
Espaços de trabalho
 workspaces array of object

Detalhes dos espaços de trabalho do Postman.
Id
 workspaces.id string

Identificador exclusivo de um espaço de trabalho.
Nome
 workspaces.name string

Nome do espaço de trabalho.
Tipo
 workspaces.type string

Tipo de espaço de trabalho, por exemplo, "pessoal".
Visibilidade
 workspaces.visibility string

Visibilidade do espaço de trabalho, por exemplo, "pessoal".

Obter ambiente

ID da Operação:
GetEnvironment

Obtém informações sobre um ambiente específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do Ambiente
 environmentId True string

ID exclusivo de um ambiente de carteiro.

Devoluções

Name Caminho Tipo Description
Id
 environment.id string

Identificador do ambiente.
Nome
 environment.name string

Nome do ambiente.
Proprietário
 environment.owner string

Identificador do proprietário do ambiente.
Criado em
 environment.createdAt string

Carimbo de data/hora da criação do ambiente, em formato UTC.
Atualizado em
 environment.updatedAt string

Carimbo de data/hora da última atualização, em formato UTC.
variables
 environment.values array of object

Matriz de valores de variáveis de ambiente.
Key
 environment.values.key string

Chave da variável de ambiente.
Valor
 environment.values.value string

Valor da variável de ambiente.
Ativado(a)
 environment.values.enabled boolean

Booleano, se a variável de ambiente está habilitada.
Tipo
 environment.values.type string

Tipo da variável de ambiente.
É público
 environment.isPublic boolean

Booleano indicando, se o ambiente é público ou não.

Obter coleção

ID da Operação:
GetCollection

Obtém informações sobre uma coleção específica de carteiros.

Parâmetros

Name Chave Necessário Tipo Description
ID da coleção
 collectionId True string

ID único de uma coleção Postman.
Tecla de Acesso
 access_key string

Valor opcional, definindo uma chave de acesso que fornece acesso somente leitura a uma coleção.

Devoluções

Name Caminho Tipo Description
Collection
 collection object

Objeto que representa uma coleção Postman.

Obter espaço de trabalho

ID da Operação:
GetWorkspace

Obtém informações sobre um espaço de trabalho específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do espaço de trabalho
 workspaceId True string

ID exclusivo de um espaço de trabalho do Postman.

Devoluções

Name Caminho Tipo Description
Id
 workspace.id string

Identificador exclusivo do espaço de trabalho.
Nome
 workspace.name string

Nome do espaço de trabalho.
Tipo
 workspace.type string

Tipo de espaço de trabalho, por exemplo, "pessoal".
Description
 workspace.description string

Descrição do espaço de trabalho.
Visibilidade
 workspace.visibility string

Visibilidade do espaço de trabalho, por exemplo, "pessoal".
Criado por
 workspace.createdBy string

Identificador exclusivo do usuário, que criou o espaço de trabalho.
Atualizado por
 workspace.updatedBy string

Identificador exclusivo do usuário, que atualizou o espaço de trabalho pela última vez.
Criado em
 workspace.createdAt string

Carimbo de data/hora da criação do espaço de trabalho no formato UTC.
Atualizado em
 workspace.updatedAt string

Carimbo de data/hora da última atualização em formato UTC.
collections
 workspace.collections array of object

Matriz de coleções dentro do espaço de trabalho.
Id
 workspace.collections.id string

Identificador exclusivo da coleção no espaço de trabalho.
Nome
 workspace.collections.name string

Nome da coleção no espaço de trabalho.
UID
 workspace.collections.uid string

ID globalmente exclusivo da coleção no espaço de trabalho
environments
 workspace.environments array of object

Matriz de ambientes dentro do espaço de trabalho.
Id
 workspace.environments.id string

Identificador do ambiente dentro do espaço de trabalho.
Nome
 workspace.environments.name string

Nome do ambiente no espaço de trabalho.
UID
 workspace.environments.uid string

Identificador global exclusivo do ambiente no espaço de trabalho.
simulações
 workspace.mocks array of object

Matriz de simulações dentro do espaço de trabalho.
Id
 workspace.mocks.id string

Identificador da simulação no espaço de trabalho.
Nome
 workspace.mocks.name string

Nome da simulação no espaço de trabalho.
UID
 workspace.mocks.uid string

Identificador global exclusivo da simulação no espaço de trabalho.
monitors
 workspace.monitors array of object

Matriz de monitores dentro do espaço de trabalho.
Id
 workspace.monitors.id string

Identificador do monitor no espaço de trabalho.
Nome
 workspace.monitors.name string

Nome do monitor no espaço de trabalho.
UID
 workspace.monitors.uid string

Identificador global exclusivo do monitor no espaço de trabalho.
apis
 workspace.apis array of object

Matriz de APIs dentro do espaço de trabalho.
Id
 workspace.apis.id string

Identificador da API no espaço de trabalho.
Nome
 workspace.apis.name string

Nome da API no espaço de trabalho.
UID
 workspace.apis.uid string

Identificador global exclusivo da API no espaço de trabalho.

Obter usuário autenticado

ID da Operação:
GetAuthenticatedUser

Obtém informações e detalhes de uso sobre o usuário autenticado.

Devoluções

Name Caminho Tipo Description
Id
 user.id integer

Identificador exclusivo do usuário.
Nome de utilizador
 user.username string

Nome de usuário para o usuário autenticado.
Email
 user.email string

Endereço de e-mail do usuário.
Nome completo
 user.fullName string

Nome completo do utilizador.
Avatar
 user.avatar string

Avatar do usuário.
É público
 user.isPublic boolean

Booleano, quer o usuário seja público ou não.
Operations
 operations array of object

Detalhes de operações e uso para o usuário.
Nome
 operations.name string

Nome da operação.
Limite
 operations.limit integer

Limite aplicável à operação.
Usage
 operations.usage integer

Detalhes de uso da operação.
Utilização excedida
 operations.overage integer

Detalhes de excesso para a operação.