PHPackages ricardo-tulio-b4x/b4x-integracao-php-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. ricardo-tulio-b4x/b4x-integracao-php-sdk ActiveLibrary[Utility & Helpers](/categories/utility) ricardo-tulio-b4x/b4x-integracao-php-sdk ======================================== b4x 1.0.1(1y ago)01MITPHPPHP ^7.2 || ^8.0 Since Apr 4Pushed 1y ago1 watchersCompare [ Source](https://github.com/RicardoAugustoTulio/b4x-integracao-php-sdk)[ Packagist](https://packagist.org/packages/ricardo-tulio-b4x/b4x-integracao-php-sdk)[ Docs](https://b4x.com.br)[ RSS](/packages/ricardo-tulio-b4x-b4x-integracao-php-sdk/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (6)Versions (3)Used By (0) Getting Started with Api B4C ============================ [](#getting-started-with-api-b4c) Introduction ------------ [](#introduction) ### Api B4C x ERP [](#api-b4c-x-erp) Documentação da API Rest para possibilitar a integração completa com a loja. *Versão Atual: \[v1.0\]\[dist\]* #### Ambientes (produção e sandbox) [](#ambientes-produção-e-sandbox) A url de acesso a API é a mesma para os dois ambientes, a identificação do tipo de acesso se dará pelo login e senha. {{URL\_API\_B4C}} #### Autenticação e Padrões [](#autenticação-e-padrões) \*\*\*Autenticação A API utiliza o padrão “HTTP Basic Authentication”, que consiste em enviar o cabeçalho Authorization com um valor no form Importante: O cabeçalho de autenticação deve ser informado em todas as requisições enviadas para a API. \###Padrões Toda as trocas de informações com a API, deve utilizar o padrão JSON (JavaScript Object Notation). Por isso, cada requisi `#Headers do formato de dados` `Accept: application/json` `Content-Type: application/json` \###Encoding (charset) Os dados enviados (via POST ou PUT) devem estar de acordo com o charset UTF-8. Caso seja utilizado um encoding diferente, será retornado um erro de tipo de dados não suportados (HTTP Status 415). \[IMPORTANTE\] - Mesmo que o header "Accept" indique o uso do charset UTF-8, se os dados do body não estiverem no encoding #### Códigos de Retorno (http status) [](#códigos-de-retorno-http-status) ##### A Api utiliza o HTTP status code para a resposta de toda requisição. [](#a-api-utiliza-o-http-status-code-para-a-resposta-de-toda-requisição) CódigoDescricao200Sucesso201Criado400Requisição inválida401Credenciais inválidas403Permissão negada ao recurso404A URL solicitada ou o recurso não existe405Método não permitido para o recurso409O recurso que está sendo criado já existe500Erro desconhecido. Por favor informe para o email sobre o problema.Install the Package ------------------- [](#install-the-package) Run the following command to install the package and automatically add the dependency to your composer.json file: ``` composer require "ricardo-tulio-b4x/b4x-integracao-php-sdk:1.0.1" ``` Or add it to the composer.json file manually as given below: ``` "require": { "ricardo-tulio-b4x/b4x-integracao-php-sdk": "1.0.1" } ``` You can also view the package at: Test the SDK ------------ [](#test-the-sdk) Unit tests in this SDK can be run using PHPUnit. 1. First install the dependencies using composer including the `require-dev` dependencies. 2. Run `vendor\bin\phpunit --verbose` from commandline to execute tests. If you have installed PHPUnit globally, run tests using `phpunit --verbose` instead. You can change the PHPUnit test configuration in the `phpunit.xml` file. Initialize the API Client ------------------------- [](#initialize-the-api-client) ***Note:*** Documentation for the client can be found [here.](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/client.md) The following parameters are configurable for the API Client: ParameterTypeDescription`environment``Environment`The API environment. **Default: `Environment.PRODUCTION`**`timeout``int`Timeout for API calls in seconds. *Default*: `0``enableRetries``bool`Whether to enable retries and backoff feature. *Default*: `false``numberOfRetries``int`The number of retries to make. *Default*: `0``retryInterval``float`The retry time interval between the endpoint calls. *Default*: `1``backOffFactor``float`Exponential backoff factor to increase interval between retries. *Default*: `2``maximumRetryWaitTime``int`The maximum wait time in seconds for overall retrying requests. *Default*: `0``retryOnTimeout``bool`Whether to retry on request timeout. *Default*: `true``httpStatusCodesToRetry``array`Http status codes to retry against. *Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524``httpMethodsToRetry``array`Http methods to retry against. *Default*: `'GET', 'PUT'``basicAuthCredentials`[`BasicAuthCredentials`](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/auth/basic-authentication.md)The Credentials Setter for Basic AuthenticationThe API client can be initialized as follows: ``` $client = ApiB4CClientBuilder::init() ->basicAuthCredentials( BasicAuthCredentialsBuilder::init( 'username', 'password' ) ) ->environment(Environment::PRODUCTION) ->build(); ``` Authorization ------------- [](#authorization) This API uses the following authentication schemes. - [`basic (Basic Authentication)`](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/auth/basic-authentication.md) List of APIs ------------ [](#list-of-apis) - [Entregasdo Pedido](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/entregasdo-pedido.md) - [Eventosda Entrega](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/eventosda-entrega.md) - [Eventos Pedidos](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/eventos-pedidos.md) - [Nf Pedidos](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/nf-pedidos.md) - [Filiais Faturamento](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/filiais-faturamento.md) - [Produtosvinculofiliais](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/produtosvinculofiliais.md) - [Observações Pedidos](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/observa%C3%A7%C3%B5es-pedidos.md) - [Categorias](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/categorias.md) - [Marcas](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/marcas.md) - [Produtos](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/produtos.md) - [Pedidos](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/pedidos.md) - [Campanha](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/campanha.md) - [Oferta](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/oferta.md) - [Quantidade](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/quantidade.md) - [Preços](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/pre%C3%A7os.md) - [Filiais](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/filiais.md) - [Usuarios](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/usuarios.md) - [Endereco](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/endereco.md) - [Descontos](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/descontos.md) - [Clientes](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/clientes.md) - [Boleto](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/boleto.md) - [Pix](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/pix.md) - [Tickets](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/tickets.md) - [Personalizacao](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/controllers/personalizacao.md) Classes Documentation --------------------- [](#classes-documentation) - [ApiException](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/api-exception.md) - [HttpRequest](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/http-request.md) - [HttpResponse](https://www.github.com/RicardoAugustoTulio/b4x-integracao-php-sdk/tree/1.0.1/doc/http-response.md) ### Health Score 26 — LowBetter than 43% of packages Maintenance46 Moderate activity, may be stable Popularity1 Limited adoption so far Community7 Small or concentrated contributor base Maturity43 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 2 Last Release 403d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/e2a6d652b8b2da9b9023e84311f6035817d67dad40c6a0cac417042c23c43ca1?d=identicon)[ricardo.tulio](/maintainers/ricardo.tulio) --- Top Contributors [![RicardoAugustoTulio](https://avatars.githubusercontent.com/u/41270886?v=4)](https://github.com/RicardoAugustoTulio "RicardoAugustoTulio (2 commits)") --- Tags B4X ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/ricardo-tulio-b4x-b4x-integracao-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/ricardo-tulio-b4x-b4x-integracao-php-sdk/health.svg)](https://phpackages.com/packages/ricardo-tulio-b4x-b4x-integracao-php-sdk) ``` ### Alternatives [square/square Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management. 793.4M21](/packages/square-square)[paypal/paypal-server-sdk PayPal's SDK for interacting with the REST APIs 53456.5k3](/packages/paypal-paypal-server-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)