Pular para o conteúdo principal

Pacote de Endpoints

O pacote de endpoints é um conjunto de scripts Python, um por chamada da API do IaaS, organizados nas mesmas seções desta documentação. Cada script monta os headers API-CLIENT-KEY e AUTHORIZATION, envia a requisição e imprime o status e a resposta. Serve para quem está integrando e quer testar uma chamada em sandbox sem escrever a assinatura do zero.

Baixar o pacote (.zip)

Configurar​

  1. Instale as dependências: pip install -r requirements.txt.

  2. Copie .env.example para .env, na raiz do pacote, e preencha:

    VariávelO que é
    BASE_URLURL base do host do seu perfil e ambiente. Veja Ambientes (Hosts).
    API_KEYChave de API da sua integração.
    PRIVATE_KEY_PATHCaminho do arquivo .pem da sua chave privada.
    ALGORITHMO algoritmo da sua chave: RS256 para RSA; ES256, ES384 ou ES512 para EC P-256, P-384 ou P-521. A chave EC P-521 da troca de chaves usa ES512.
  3. Abra o script, troque os valores marcados com <...> e rode. Comece por 5.1 - Primeiros passos/5.1 - GET Teste de autenticação.py.

A chave de API só funciona no host do seu perfil

Nem toda chamada existe em todos os hosts. O cabeçalho de cada script lista os hosts que expõem aquela chamada, e o README.md do pacote traz a tabela por pasta. Chamada para o host de outro perfil é recusada com Invalid API Key.

Aviso Importante!

Os scripts usam CPFs e CNPJs fictícios. Não use dados reais de pessoas físicas ou jurídicas em sandbox.