Download the PHP package handsondigital/lib.php.idplugger without Composer

On this page you can find all versions of the php package handsondigital/lib.php.idplugger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of handsondigital/lib.php.idplugger

Informations about the package lib.php.idplugger

handsondigital/lib.php.idplugger

Introdução

Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma.

Sobre a API

Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas.

Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais.

Começando

Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos:

  1. Autenticação: Obtenha suas credenciais de autenticação ('username' e 'password'), junto ao nosso time comercial, para acessar a API.

  2. Explorar Endpoints: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades.

  3. Experimentar: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento.

  4. Integrar: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades.

Autenticação

Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção.

Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato:

Header Valor
Authorization bearer {token}

Substitua {token} pelo token obtido na autenticação.

IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação.

Webhooks

Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API.

Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">/webhook.

Ambiente de testes

Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, sem ônus à pessoa desenvolvedora. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção.

Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico.

Vamos começar a promover o sucesso juntos!

Postman Collection

<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ArticlesApi articlesCreate POST /v3/promotion/{promotion_id}/cms/articles Cadastra publicações na promoção
ArticlesApi articlesDelete DELETE /v3/promotion/{promotion_id}/cms/articles/{id} Exclui uma publicação da promoção
ArticlesApi articlesIndex GET /v3/promotion/{promotion_id}/cms/articles Lista as publicações cadastradas na promoção
ArticlesApi articlesUpdate PATCH /v3/promotion/{promotion_id}/cms/articles Cadastra ou atualiza publicações na promoção
AuthApi authLoginByToken POST /v3/auth/login Login na API via e-mail e token
AuthApi authRefreshToken POST /v3/auth/refresh Renova o do token de autenticação
AuthApi authRequestToken POST /v3/auth/request-token Solicita envio de token de login por email
AuthApi login POST /v3/login Login na API
AuthApi me GET /v3/me Dados na API
AwardedsApi awardedsSearch GET /v3/promotion/{promotion_id}/awardeds Busca por usuários cadastrados na promoção ganhadores de sorteios
AwardedsApi awardedsStates GET /v3/promotion/{promotion_id}/awardeds/states Lista os status de ganhador existentes na promoção
AwardedsApi awardedsUpdate PATCH /v3/promotion/{promotion_id}/awardeds Atualiza informações referentes aos ganhadores de sorteios da promoção
AwardsApi awardsCreate POST /v3/promotion/{promotion_id}/awards Cadastra um prêmio na promoção
AwardsApi awardsDelete DELETE /v3/promotion/{promotion_id}/awards/{id} Deleta um prêmio da promoção
AwardsApi awardsIndex GET /v3/promotion/{promotion_id}/awards Pesquisa por prêmios na promoção
AwardsApi awardsUpdate PATCH /v3/promotion/{promotion_id}/awards Cadastra ou atualiza um prêmio na promoção
BlockedUsersApi blacklistCreate POST /v3/promotion/{promotion_id}/users/blacklist Cadastra um CPF na lista de CPFs bloqueados na promoção
BlockedUsersApi blacklistDelete DELETE /v3/promotion/{promotion_id}/users/blacklist/{id} Exclui um CPF da lista de CPFs bloqueados da promoção
BlockedUsersApi blacklistIndex GET /v3/promotion/{promotion_id}/users/blacklist Pesquisa por CPFs bloqueados na promoção
BrandingApi brandingIndex GET /v3/promotion/{promotion_id}/cms/branding Dados referentes a identidade visual da marca da promoção
BrandingApi brandingUpdate POST /v3/promotion/{promotion_id}/cms/branding Altera os dados referentes a identidade visual da marca da promoção
ContentApi contentCreate POST /v3/promotion/{promotion_id}/cms/content Cria um novo conteúdo para a promoção
ContentApi contentIndex GET /v3/promotion/{promotion_id}/cms/content Dados referentes aos conteúdos (que não são artigos de blog) da promoção
CouponsApi couponsCreate POST /v3/promotion/{promotion_id}/users/{user_id}/coupons Cadastra um cupom para um usuário cadastrado na promoção
CouponsApi couponsDelete DELETE /v3/promotion/{promotion_id}/users/{user_id}/coupons/{coupon_id} Exclui um cupom de um usuário cadastrado na promoção
CouponsApi couponsIndex GET /v3/promotion/{promotion_id}/users/{user_id}/coupons Busca por cupons de um usuário cadastrado na promoção
CouponsApi couponsUpdate PATCH /v3/promotion/{promotion_id}/users/{user_id}/coupons Cadastra ou atualiza um cupom para um usuário cadastrado na promoção
CouponsApi cuponsWebhook POST /webhook-do-cupom Webhook de resposta ao registro de cupons
CouponsApi v3PromotionPromotionIdCouponsGet GET /v3/promotion/{promotion_id}/coupons Buscar cupons de uma promoção
DocumentRulesApi documentRulesIndex GET /v3/promotion/{promotion_id}/cms/document_rules Termos de uso, regulamentos e política de privacidade da promoção
DocumentRulesApi documentRulesRegulationDelete DELETE /v3/promotion/{promotion_id}/cms/document_rules/regulation/{regulation_id} Exclui um regulamento da promoção
DocumentRulesApi documentRulesUpdate POST /v3/promotion/{promotion_id}/cms/document_rules Atualiza os termos de uso e regulamento da promoção
FAQApi faqCreate POST /v3/promotion/{promotion_id}/cms/faq Cadastra perguntas frequentes na promoção
FAQApi faqDelete DELETE /v3/promotion/{promotion_id}/cms/faq Esclui perguntas frequentes na promoção
FAQApi faqIndex GET /v3/promotion/{promotion_id}/cms/faq Lista as perguntas frequentes cadastradas na promoção
FAQApi faqUpdate PATCH /v3/promotion/{promotion_id}/cms/faq Cadastra ou atualiza perguntas frequentes na promoção
FilesApi filesShow GET /v3/promotion/{promotion_id}/files/{filename} Faz o download de um arquivo
InstantAwardsApi instantAwardAttempts GET /v3/promotion/{promotion_id}/users/{user_id}/attempts Retorna a quantidade de chances usadas e restantes de um participante da promoção
InstantAwardsApi instantAwardTryToWin POST /v3/promotion/{promotion_id}/users/{user_id}/try_to_win Realiza a tentativa de ganho de um prêmio instantâneo para o participante da promoção
LuckyNumbersApi luckyNumbersAddCustom POST /v3/promotion/{promotion_id}/lucky_numbers Cadastra Números da Sorte no repositório da promoção
LuckyNumbersApi luckyNumbersRemove POST /v3/promotion/{promotion_id}/users/{user_id}/lucky_numbers/remove Inativa e remove Números da Sorte cadastrados na promoção
LuckyNumbersApi luckyNumbersSearch GET /v3/promotion/{promotion_id}/users/{user_id}/lucky_numbers Busca por Números da Sorte de um usuário cadastrado na promoção
MetricsApi metrics GET /v3/promotion/{promotion_id}/metrics Devolve as métricas da promoção
OrdersApi ordersCreate POST /v3/promotion/{promotion_id}/users/{user_id}/orders Cadastra um pedido para um usuário na promoção
OrdersApi ordersIndex GET /v3/promotion/{promotion_id}/users/{user_id}/orders Pesquisa por pedidos na promoção
OrdersApi ordersUpdate PATCH /v3/promotion/{promotion_id}/users/{user_id}/orders Cadastra ou atualiza um pedido de um usuário na promoção
ProductsApi productsCreate POST /v3/promotion/{promotion_id}/products Cadastra um produto na promoção
ProductsApi productsDelete DELETE /v3/promotion/{promotion_id}/products/{product_id} Exclui um produto cadastrado na promoção
ProductsApi productsIndex GET /v3/promotion/{promotion_id}/products Busca por produtos cadastrados na promoção
ProductsApi productsUpdate PATCH /v3/promotion/{promotion_id}/products Cadastra ou atualiza produtos na promoção
PromotionDataApi configsIndex GET /v3/promotion/{promotion_id} Retorna dados da promoção
RafflesApi rafflesCreate POST /v3/promotion/{promotion_id}/raffles Cadastra um sorteio na promoção
RafflesApi rafflesDelete DELETE /v3/promotion/{promotion_id}/raffles/{id} Exclui um sorteio da promoção
RafflesApi rafflesIndex GET /v3/promotion/{promotion_id}/raffles Pesquisa por sorteios na promoção
RafflesApi rafflesReport POST /v3/promotion/{promotion_id}/raffles/{id}/report Envia por e-mail o relatório de cupons participantes de um sorteio
RafflesApi rafflesUpdate PATCH /v3/promotion/{promotion_id}/raffles Cadastra ou atualiza um sorteio na promoção
SettingsApi configWebhook POST /v3/promotion/{promotion_id}/webhook Configura o webhook da promoção
StoresApi storesCreate POST /v3/promotion/{promotion_id}/stores Cadastra uma loja na promoção
StoresApi storesDelete DELETE /v3/promotion/{promotion_id}/stores/{store_id} Exclui um produto cadastrado na promoção
StoresApi storesIndex GET /v3/promotion/{promotion_id}/stores Busca por lojas cadastradas na promoção
StoresApi storesUpdate PATCH /v3/promotion/{promotion_id}/stores Cadastra ou atualiza lojas na promoção
TicketsApi ticketsCreate POST /v3/promotion/{promotion_id}/tickets Cadastra um ticket de suporte na promoção
TicketsApi ticketsDelete DELETE /v3/promotion/{promotion_id}/tickets/{id} Exclui um ticket de suporte da promoção
TicketsApi ticketsIndex GET /v3/promotion/{promotion_id}/tickets Busca por tickets de suporte cadastrados na promoção
TicketsApi ticketsUpdate PATCH /v3/promotion/{promotion_id}/tickets Cadastra ou atualiza um ticket de suporte na promoção
UsersApi usersCreate POST /v3/promotion/{promotion_id}/users Cadastra um usuário na promoção
UsersApi usersDelete DELETE /v3/promotion/{promotion_id}/users/{user_id} Exclui um usuário da promoção
UsersApi usersIndex GET /v3/promotion/{promotion_id}/users Busca por um usuário cadastrado na promoção
UsersApi usersUpdate PATCH /v3/promotion/{promotion_id}/users Cadastra ou atualiza um usuário na promoção
UsersApi usersWebhook POST /webhook-do-usuario Webhook de resposta ao registro de usuário

Models

Authorization

Authentication schemes defined for the API:

bearerAuth

Tests

To run the tests, use:

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

All versions of lib.php.idplugger with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package handsondigital/lib.php.idplugger contains the following files

Loading the files please wait ...