Pular para conteúdo

Visão Geral da API do PLDPro SDK

O projeto PLDPro SDK é composto por duas APIs principais: a API de baixo nível (pldpro_sdk.api_client) e a API de alto nível (pldpro_sdk.core).
Além disso, a documentação da API REST do PLDPro está disponível via Swagger para facilitar a exploração e o entendimento dos endpoints disponíveis.

Referência Completa das APIs

A documentação completa das APIs do PLDPro SDK pode ser encontrada nos seguintes locais:

API de Baixo Nível (pldpro_sdk.api_client)

A API do cliente é responsável por fornecer as definições dos modelos de dados e os métodos para interagir com os endpoints da API REST do PLDPro. Ela é gerada automaticamente a partir da especificação OpenAPI da API do PLDPro, garantindo que todas as chamadas de API estejam alinhadas com a implementação do servidor.

Características:

  • Mapeamento direto dos endpoints REST

  • Modelos de dados correspondentes à especificação OpenAPI

  • Controle total sobre requisições e respostas

  • Ideal para cenários que exigem customização avançada

API de Alto Nível (pldpro_sdk.core)

A API de alto nível é construída sobre a API do cliente e oferece uma camada de abstração adicional, facilitando o uso do SDK. Ela encapsula a lógica de negócios e fornece métodos de alto nível para operações comuns, como gerenciamento de hosts e casos.

Características:

  • Abstração de operações complexas

  • Métodos simplificados e intuitivos

  • Gerenciamento automático de recursos

  • Ideal para desenvolvimento rápido e produtivo

Documentação da API REST (Swagger)

Para referência completa de todos os endpoints disponíveis, parâmetros e modelos de dados da API REST do PLDPro, consulte a documentação interativa e detalhada em PLDPro API Swagger UI.

A documentação Swagger fornece:

  • Especificação completa da API REST

  • Teste interativo de endpoints

  • Modelos de requisição e resposta

  • Exemplos de uso para cada operação

Escolhendo a API Adequada

Para melhor compreensão, é apresentada a tabela comparativa para ajudar na escolha da API mais adequada para diferentes cenários:

Cenário Recomendação
Testar endpoints específicos Use Swagger UI
Integração em Python com controle total Use API de Baixo Nível
Desenvolvimento rápido em Python Use API de Alto Nível
Verificar especificação da API Use Swagger UI
Automatizar operações complexas Use API de Alto Nível