PHPackages                             pedroquezado/api-loader - 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. [Framework](/categories/framework)
4. /
5. pedroquezado/api-loader

ActiveLibrary[Framework](/categories/framework)

pedroquezado/api-loader
=======================

A library for loading and interacting with APIs

1.0.2(2y ago)06MITPHPPHP >=8.0

Since Jun 30Pushed 2y ago1 watchersCompare

[ Source](https://github.com/pedroquezado/api-loader)[ Packagist](https://packagist.org/packages/pedroquezado/api-loader)[ Docs](https://www.pedroquezado.com.br)[ RSS](/packages/pedroquezado-api-loader/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (1)Versions (4)Used By (0)

api-loader - PedroQuezado
=========================

[](#api-loader---pedroquezado)

[![Maintainer](https://camo.githubusercontent.com/0a080976a7491620e4b9edfc914dd655ac5dd452570d344c0980aff4e8f99428/687474703a2f2f696d672e736869656c64732e696f2f62616467652f6d61696e7461696e65722d40706564726f7175657a61646f2d626c75652e7376673f7374796c653d666c61742d737175617265)](https://github.com/pedroquezado)[![Source Code](https://camo.githubusercontent.com/aaebc9a441ce72d6f2c36da1178b181096ca649cfc32f88c0ea65803993788dd/687474703a2f2f696d672e736869656c64732e696f2f62616467652f736f757263652d706564726f7175657a61646f2f6170692d6c6f616465722d626c75652e7376673f7374796c653d666c61742d737175617265)](https://github.com/pedroquezado/api-loader)[![PHP from Packagist](https://camo.githubusercontent.com/6e05e357b769356e86a14efb6ef581e7abc7de95468852a9a5708a2f9f0305ad/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f706564726f7175657a61646f2f6170692d6c6f616465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/pedroquezado/api-loader)[![Latest Version](https://camo.githubusercontent.com/c0c4851371e9dced5c609226526002a25e9ec68420738e5d1e801d697cadedb1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f706564726f7175657a61646f2f6170692d6c6f616465722e7376673f7374796c653d666c61742d737175617265)](https://github.com/pedroquezado/api-loader/releases)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Build](https://camo.githubusercontent.com/16b5d6aa55b6d1a83efe8bb75c180d93c534b74edad608e3969c7fd9d1b03d71/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f6275696c642f672f706564726f7175657a61646f2f6170692d6c6f616465722e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/pedroquezado/api-loader)[![Quality Score](https://camo.githubusercontent.com/7df19f65952414341de2ad263bd399eb9fd84587d923cc22f9c3cd284f50cced/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f706564726f7175657a61646f2f6170692d6c6f616465722e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/pedroquezado/api-loader)[![Total Downloads](https://camo.githubusercontent.com/29fe94e74b806790029284280488a7ab0d5d3b237351901cca13476955c1f00d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f706564726f7175657a61646f2f6170692d6c6f616465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/pedroquezado/api-loader)

About API-Loader
----------------

[](#about-api-loader)

API Client Library
==================

[](#api-client-library)

A library for interacting with various APIs.

Descrição
---------

[](#descrição)

Esta biblioteca fornece uma interface conveniente para se comunicar com várias APIs. Ela oferece métodos para executar solicitações HTTP, autenticar-se nas APIs e realizar várias ações, como recuperar dados, criar, atualizar e excluir recursos.

Instalação
----------

[](#instalação)

Para começar a usar a biblioteca, siga as etapas abaixo:

1. Clone este repositório para o seu ambiente local.
2. Execute o comando `composer require pedroquezado/api-loader` para instalar as dependências.

Configuração
------------

[](#configuração)

Antes de poder usar a biblioteca, você precisará configurar suas chaves de acesso à API.

### Configurando as chaves de acesso

[](#configurando-as-chaves-de-acesso)

A classe `APIClient` oferece dois métodos para configurar as chaves de acesso:

#### setApiKey(apiKey, \[titleKey\])

[](#setapikeyapikey-titlekey)

Configura a chave de acesso à API.

- `apiKey` (string): A chave de acesso à API.
- `titleKey` (string, opcional): O título do cabeçalho a ser usado ao enviar a chave de acesso (padrão: "Access-Token").

Exemplo:

```
$apiClient->setApiKey('SEU_ACCESS_TOKEN', 'nomear_ApiKey');
```

#### setSecretApiKey(secretApiKey, \[titleKey\])

[](#setsecretapikeysecretapikey-titlekey)

Configura a chave de acesso secreta.

- `secretApiKey` (string): A chave de acesso secreta.
- `titleKey` (string, opcional): O título do cabeçalho a ser usado ao enviar a chave de acesso secreta (padrão: "Secret-Access-Token").

Exemplo:

```
$apiClient->setSecretApiKey('SUA_SECRET_ACCESS_TOKEN', 'nomear_SecretApiKey');
```

Métodos de Ações
----------------

[](#métodos-de-ações)

A classe `APIClient` fornece os seguintes métodos para interagir com as APIs:

### get(path, \[params\])

[](#getpath-params)

Realiza uma solicitação GET para o caminho especificado.

- `path` (string): O caminho da API para a solicitação.
- `params` (array, opcional): Parâmetros de consulta para incluir na solicitação (padrão: \[\]).

Exemplo:

```
$response = $apiClient->get('/produtos', ['categoria' => 'eletrônicos']);
```

### getWithPagination(path, \[params\])

[](#getwithpaginationpath-params)

Realiza uma solicitação GET para o caminho especificado, com suporte a paginação.

- `path` (string): O caminho da API para a solicitação.
- `params` (array, opcional): Parâmetros de consulta para incluir na solicitação (padrão: \[\]). Exemplo:

```
$response = $apiClient->getWithPagination('/pedidos', ['status' => 'Em Aberto']);
```

### post(path, data)

[](#postpath-data)

Realiza uma solicitação POST para o caminho especificado com os dados fornecidos.

- `path` (string): O caminho da API para a solicitação.
- `data` (array): Os dados a serem enviados na solicitação. Exemplo:

```
$response = $apiClient->post('/produtos', ['nome' => 'Produto A', 'preco' => 100]);
```

### put(path, data)

[](#putpath-data)

Realiza uma solicitação PUT para o caminho especificado com os dados fornecidos.

- `path` (string): O caminho da API para a solicitação.
- `data` (array): Os dados a serem enviados na solicitação. Exemplo:

```
$response = $apiClient->put('/produtos/1', ['preco' => 120]);
```

### delete(path)

[](#deletepath)

Realiza uma solicitação DELETE para o caminho especificado.

- `path` (string): O caminho da API para a solicitação. Exemplo:

```
$response = $apiClient->delete('/produtos/1');
```

Exemplo de Uso
==============

[](#exemplo-de-uso)

Aqui está um exemplo de código que demonstra o uso da biblioteca:

```