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

On this page you can find all versions of the php package handsondigital/lib.php.admin.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.admin.idplugger

Informations about the package lib.php.admin.idplugger

handsondigital/lib.php.admin.idplugger

Introdução

Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger exclusiva para administradores da API!

Se você está procurando a documentação destinada ao cliente da Plataforma de Promoção IdPlugger acesse clicando aqui!

Sobre a API

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

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. Postman: Baixe a collection do postman, instale o postman na sua máquina e importe a collection.

  2. Autenticação: Obtenha suas credenciais de autenticação ('username' e 'password') de administrador, para acessar a API.

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

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

  5. 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.

Este token é do tipo bearer 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 bearer token tem um tempo de validade, o ideal é armazenar o bearer token 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.

Configurações de Promoção

Pull Configurations

O primeiro passo para configurar uma promoção na API é puxar a parametrização da promoção criada. Para isto, libere o servidor da API para acesso ao banco de dados da promoção e informe os dados de conexão através da rota Pull Configuration

Steps

Após puxar as configurações na etapa anterior, configure as steps da promoção. Steps são as partes de código que serão executadas para cada promoção. Cada promoção pode ter uma configuração diferente de steps.

Algumas steps são configuradas por padrão ao fazer o pull configuration, para saber quais confira o parâmetro default na resposta do endpoint de consulta de steps. Este endpoint também retorna a descrição do que a step faz e se ela depende que outra esteja ativada ou desativada.

Criar Usuário da API

Para que um cliente possa utilizar a API, é necessário criar um usuário para ele.

Para isto, após fazer o pull configuration e a parametrização de steps, utilize este endpoint para criar um usuário da API. Este endpoint cria o usuário e retorna uma senha para este usuário.

Permissões do usuário da API

Após criar o usuário, é necessário dar as permissões para que ele possa atuar na promoção. Para isso, utilize este endpoint.

Atenção: Selecione bem as permissões, deixando apenas as necessárias.

Teste

Utilize as credenciais do usuário criado para testar se a API está respondendo para a promoção configurada.

Postman Collection

<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">\n\n# Limite de Frequência (Rate Limit)\n\nA resposta da API Idplugger quando o limite de frequência (rate limit) é atingido é um código de status HTTP 429 (Too Many Requests).\n\nDetalhes do retorno:\n\n1. Código de Status HTTP: 429 Too Many Requests.\n2. Corpo da Resposta (Body): Um JSON contendo a mensagem de erro: {\"message\": \"Too Many Requests\"}.\n3. Cabeçalhos HTTP (Headers):\n - X-RateLimit-Limit: O limite total permitido.\n - X-RateLimit-Remaining: Quantidade de requisições restantes.\n - Retry-After: Segundos a esperar antes da próxima tentativa.\n - X-RateLimit-Reset: Timestamp de quando o limite será zerado.

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 https://api.idplugger.com

Class Method HTTP request Description
ApiLogsApi adminLogsGet GET /admin/logs List API logs
ApiLogsApi adminLogsIdGet GET /admin/logs/{id} Get specific API log
AuthApi adminAuthRequestToken POST /admin/auth/request-token Solicita envio de token de login por email
AuthApi authLogin POST /v3/login Login na API
AuthApi authLoginByToken POST /admin/auth/login Login na API via e-mail e token
AuthApi authMe GET /v3/me Dados na API
AuthApi authRefreshToken POST /admin/auth/refresh Renova o do token de autenticação
ConfigsApi adminPromotionConfigsIndex GET /v3/admin/promotion/{promotion_id}/configs Listar configurações de uma promoção
ConfigsApi adminPromotionConfigsShow GET /v3/admin/promotion/{promotion_id}/configs/{key} Buscar configuração por chave
ConfigsApi adminPromotionConfigsStore POST /v3/admin/promotion/{promotion_id}/configs Criar nova configuração
ConfigsApi adminPromotionConfigsUpdate PUT /v3/admin/promotion/{promotion_id}/configs/{key} Atualizar configuração por chave
ConfigsApi adminPromotionConfigsUpsert POST /v3/admin/promotion/{promotion_id}/configs/upsert Criar ou atualizar configuração por chave (upsert)
ConfigsApi adminPromotionConfigsValidKeys GET /v3/admin/promotion/{promotion_id}/configs/valid-keys Listar chaves válidas do ConfigKeyEnum
CustomerServiceApi adminServiceCustomerApplications GET /admin/service/customer/applications/{client_id} Listar aplicações de um cliente no serviço de atendimento ao cliente
CustomerServiceApi adminServiceCustomerBrands GET /admin/service/customer/brands/{client_id} Listar marcas de um cliente do serviço de atendimento ao cliente
CustomerServiceApi adminServiceCustomerCampaigns GET /admin/service/customer/campaigns/{client_id} Listar campanhas de um cliente no serviço de atendimento ao cliente
CustomerServiceApi adminServiceCustomerClients GET /admin/service/customer/clients Listar clientes do serviço de atendimento ao cliente
ErrorReportsApi adminErrorsGet GET /admin/errors List error reports
ErrorReportsApi adminErrorsIdDelete DELETE /admin/errors/{id} Delete error report
ErrorReportsApi adminErrorsIdGet GET /admin/errors/{id} Get specific error report
ErrorsApi adminErrorsDestroy DELETE /v3/admin/errors/{id} Deletar relatório de erro
ErrorsApi adminErrorsIndex GET /v3/admin/errors/ Listar relatórios de erro
ErrorsApi adminErrorsShow GET /v3/admin/errors/{id} Visualizar erro específico
LogsApi adminLogsIndex GET /v3/admin/logs/ Listar logs de requisições da API
LogsApi adminLogsShow GET /v3/admin/logs/{id} Visualizar log específico
MetricsApi metrics GET /v3/metrics Devolve as métricas da promoção
PermissionsApi adminPermissionsByAction GET /v3/admin/permissions/action Buscar permissões por ação
PermissionsApi adminPermissionsByCategory GET /v3/admin/permissions/category Buscar permissões por categoria
PermissionsApi adminPermissionsCategories GET /v3/admin/permissions/categories Listar todas as categorias de permissões
PermissionsApi adminPermissionsGrouped GET /v3/admin/permissions/grouped Listar permissões agrupadas por categoria
PermissionsApi adminPermissionsIndex GET /v3/admin/permissions/ Listar todas as permissões
PermissionsApi adminPermissionsShow GET /v3/admin/permissions/{key} Buscar permissão específica por chave
PromotionApi adminPromotionCacheClear POST /v3/admin/promotion/{promotion_id}/cache/clear Renova o cache de uma promoção na API
PromotionApi adminPromotionInactivate POST /v3/admin/promotion/{promotion_id}/inactivate Inativar uma promoção
PromotionApi adminPromotionLuckyNumbersReset POST /v3/admin/promotion/{promotion_id}/lucky-numbers/reset Resetar números da sorte de uma promoção
PromotionApi promotionPullConfiguration POST /v3/admin/pullconfiguration Adicionar/Atualizar configurações de uma promoção ao orquestrador
PromotionApi promotionSetup POST /v3/admin/promotion/setup Setup automatizado de ambiente de promoção
PromotionApi promotionStart POST /v3/admin/promotion/start Iniciar uma promoção na API
RolesApi rolesAttachPermissions POST /v3/admin/roles/{id}/permissions Atualizar permissões de uma role
RolesApi rolesDestroy DELETE /v3/admin/roles/{id} Remover role
RolesApi rolesIndex GET /v3/admin/roles Listar roles
RolesApi rolesPermissions GET /v3/admin/roles/{id}/permissions Listar permissões de uma role
RolesApi rolesShow GET /v3/admin/roles/{id} Exibir detalhes da role
RolesApi rolesStore POST /v3/admin/roles Criar role
RolesApi rolesUpdate PATCH /v3/admin/roles/{id} Atualizar role
StepsApi stepsAllow POST /v3/steps/allow Inclui uma Step em um determinado endpoint
StepsApi stepsIndex GET /v3/steps Retorna todas as steps existentes
StepsApi stepsUnallow POST /v3/steps/disallow Remove uma Step de um determinado endpoint
TemplatesApi templatesDelete DELETE /v3/promotion/{promotion_id}/cms/templates/{templateKey} Restaurar template para o padrão (deletar customização)
TemplatesApi templatesIndex GET /v3/promotion/{promotion_id}/cms/templates Listar templates de e-mail da promoção
TemplatesApi templatesShow GET /v3/promotion/{promotion_id}/cms/templates/{templateKey} Buscar um template específico
TemplatesApi templatesUpdate PATCH /v3/promotion/{promotion_id}/cms/templates Atualizar um ou mais templates de e-mail
TemplatesApi templatesVariables GET /v3/promotion/{promotion_id}/cms/templates/variables Listar variáveis disponíveis para os templates de e-mail
UserApi adminUsersList GET /v3/admin/user Listar usuários da API
UserApi userGrantPermissions POST /v3/admin/user/grantpermissions Dar permissões a um usuário na API
UserApi userRegister POST /v3/admin/user/register Registrar usuário na API
UserApi userResetPassword POST /v3/admin/user/resetpassword Resetar senha do usuário na API
UserApi userShow GET /v3/admin/user/{uuid} Visualizar dados do usuário na API
UserApi userUpdate PATCH /v3/admin/user/{uuid} Atualizar nome do usuário na API

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.admin.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.admin.idplugger contains the following files

Loading the files please wait ...