Ações da API

Ações de API são ações para enviar solicitações HTTP

Parâmetros de ações

url - URL para onde a solicitação será enviada

data (opcional) - Conteúdo que será enviado como corpo da solicitação, pode ser uma string, um dicionário, lista de tuplas, bytes ou objeto semelhante a arquivo

headers (opcional) - Dicionário de cabeçalhos HTTP para enviar com a solicitação

json (opcional) - Um dicionário como um objeto semelhante a JSON a ser enviado como o corpo da solicitação hte

params (opcional) - Query strings que serão enviadas a pedido como dicionário, lista de tuplas ou bytes

cookies (opcional) - Objeto Dict ou CookieJar para enviar com a solicitação

auth_user (opcional) - Usuário para autenticar com a url

auth_pass (opcional) - Senha para autenticar com a url

files (opcional) - Dicionário de 'name': file-like-objects (ou {'name': file-tuple}) para upload de codificação em várias partes. file-tuple pode ser uma tupla de 2 ('filename', fileobj), 3-tuple ('filename', fileobj, 'content_type') ou uma tupla de 4 ('filename', fileobj, 'content_type', custom_headers), onde 'content-type' é uma string que define o tipo de conteúdo do arquivo fornecido e custom_headers um objeto do tipo dict contendo cabeçalhos adicionais a serem adicionados ao arquivo.

arquivos = {'arquivo': open('relatório.xls', 'rb')}

api.post('https://systemexample.com', files=files)

Você também pode enviar strings para serem recebidas como arquivos:

arquivos = {'arquivo': ('relatório.csv', 'algum,dados,para,enviar
anoutro,linha,para,enviar
')}

api.post('https://systemexample.com', files=files)

timeout (opcional) - Quantos segundos esperar para o servidor enviar dados antes de desistir, como um float

allow_redirects (opcional) - Pode ser definido como True ou False, para habilitar/desabilitar o redirecionamento GET/POST/PUT/PATCH/DELETE. (Padrões=Verdadeiro)

proxies (opcional) - Protocolo de mapeamento de dicionário para a URL do proxy

verify (opcional) - Ou um booleano, caso em que controla se verificamos o certificado TLS do servidor, ou uma string, nesse caso deve ser um caminho para um pacote de CA a ser usado. Padrões para Verdadeiro

stream - (opcional) - Se False, o conteúdo da resposta será baixado imediatamente

cert (opcional) - se String, caminho para o arquivo de certificado do cliente SSL (.pem). Se Tuple, ('cert', 'key') par

Ações

api.get

Faça uma solicitação usando o método GET

Parâmetros:

Uma lista completa de todos os parâmetros de ações pode ser encontrada em este link

Retornar:

content - Retorna o conteúdo da resposta

encoding - Retorna a codificação usada para decodificar response.content

headers - Retorna um dicionário de cabeçalhos de resposta

json - Retorna um objeto JSON do resultado, Nenhum se a resposta não estiver no formato JSON

reason - Retorna um texto correspondente ao código de status. Por exemplo, 'OK' para 200, 'Não encontrado' para 404

status_code - Retorna o código de status para indicar o status da resposta

url - Retorna o URL da resposta após todos os redirecionamentos, se feito

api.post

Faça uma solicitação usando o método POST

Parâmetros:

Uma lista completa de todos os parâmetros de ações pode ser encontrada em este link

Retornar:

content - Retorna o conteúdo da resposta

encoding - Retorna a codificação usada para decodificar response.content

headers - Retorna um dicionário de cabeçalhos de resposta

json - Retorna um objeto JSON do resultado, Nenhum se a resposta não estiver no formato JSON

reason - Retorna um texto correspondente ao código de status. Por exemplo, 'OK' para 200, 'Não encontrado' para 404

status_code - Retorna o código de status para indicar o status da resposta

url - Retorna o URL da resposta após todos os redirecionamentos, se feito

api.put

Faça uma solicitação usando o método PUT

Parâmetros:

Uma lista completa de todos os parâmetros de ações pode ser encontrada em este link

Retornar:

content - Retorna o conteúdo da resposta

encoding - Retorna a codificação usada para decodificar response.content

headers - Retorna um dicionário de cabeçalhos de resposta

json - Retorna um objeto JSON do resultado, Nenhum se a resposta não estiver no formato JSON

reason - Retorna um texto correspondente ao código de status. Por exemplo, 'OK' para 200, 'Não encontrado' para 404

status_code - Retorna o código de status para indicar o status da resposta

url - Retorna o URL da resposta após todos os redirecionamentos, se feito

api.delete

Faça uma solicitação usando o método DELETE

Parâmetros:

Uma lista completa de todos os parâmetros de ações pode ser encontrada em este link

Retornar:

content - Retorna o conteúdo da resposta

encoding - Retorna a codificação usada para decodificar response.content

headers - Retorna um dicionário de cabeçalhos de resposta

json - Retorna um objeto JSON do resultado, Nenhum se a resposta não estiver no formato JSON

reason - Retorna um texto correspondente ao código de status. Por exemplo, 'OK' para 200, 'Não encontrado' para 404

status_code - Retorna o código de status para indicar o status da resposta

url - Retorna o URL da resposta após todos os redirecionamentos, se feito

api.patch

Faça uma solicitação usando o método PATCH

Parâmetros:

Uma lista completa de todos os parâmetros de ações pode ser encontrada em este link

Retornar:

content - Retorna o conteúdo da resposta

encoding - Retorna a codificação usada para decodificar response.content

headers - Retorna um dicionário de cabeçalhos de resposta

json - Retorna um objeto JSON do resultado, Nenhum se a resposta não estiver no formato JSON

reason - Retorna um texto correspondente ao código de status. Por exemplo, 'OK' para 200, 'Não encontrado' para 404

status_code - Retorna o código de status para indicar o status da resposta

url - Retorna o URL da resposta após todos os redirecionamentos, se feito