Pular para conteúdo

Como o SDK Funciona

O PLDPro SDK atua como uma ponte entre o seu código e a infraestrutura de backend que executa as operações solicitadas. Ele encapsula a complexidade das chamadas de API, autenticação e gerenciamento de sessões, permitindo que você se concentre na lógica do seu aplicativo.

Fluxo de Trabalho

  1. Inicialização: Ao importar o SDK e criar uma instância do cliente, você configura a autenticação e as credenciais necessárias para se comunicar com o backend.

  2. Criação de Objetos: Você pode criar e manipular objetos como arquivos, nodes e execuções usando as classes fornecidas pelo SDK.

  3. Operações: O SDK oferece métodos para realizar operações comuns, como upload de arquivos, criação de nodes e execução de casos remotamente.

  4. Comunicação com o Backend: O SDK traduz suas chamadas de método em solicitações HTTP apropriadas, gerenciando cabeçalhos, parâmetros e corpo da solicitação conforme necessário.

  5. Tratamento de Respostas: As respostas do backend são processadas pelo SDK, que converte os dados recebidos em objetos Python utilizáveis.

  6. Gerenciamento de Erros: O SDK inclui mecanismos para capturar e tratar erros que possam ocorrer durante a comunicação com o backend, fornecendo mensagens de erro claras e acionáveis.

O diagrama abaixo ilustra o fluxo geral de interação entre o usuário, o SDK e o backend:

flowchart TD
    U[Usuário] --> S[PLDPro SDK]

    S -->|Configuração| C[Autenticação]
    S -->|Criação| O[Objetos do SDK]
    S -->|Execução| R[Operações]

    R --> B[PLDPro API]
    B --> S

    S -->|Sucesso| U
    S -->|Erro tratado| U

Benefícios

  • Simplicidade: Abstrai a complexidade das interações com a API.
  • Eficiência: Reduz o tempo de desenvolvimento ao fornecer funcionalidades prontas para uso.
  • Consistência: Garante que todas as operações sigam os padrões definidos pela API do backend.
  • Flexibilidade: Permite a integração fácil com outros sistemas e fluxos de trabalho.
  • Manutenção: Facilita a atualização e manutenção do código, já que as mudanças na API podem ser gerenciadas dentro do SDK.

Compreender como o SDK funciona ajuda a maximizar seu uso e a integrar suas funcionalidades de maneira eficaz em seus projetos.