Download the PHP package pedroquezado/api-loader without Composer
On this page you can find all versions of the php package pedroquezado/api-loader. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pedroquezado/api-loader
More information about pedroquezado/api-loader
Files in pedroquezado/api-loader
Package api-loader
Short Description A library for loading and interacting with APIs
License MIT
Homepage https://www.pedroquezado.com.br
FAQ
Example:
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 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.
Informations about the package api-loader
api-loader - PedroQuezado
About API-Loader
API Client Library
A library for interacting with various APIs.
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
Para começar a usar a biblioteca, siga as etapas abaixo:
- Clone este repositório para o seu ambiente local.
- Execute o comando
composer require pedroquezado/api-loaderpara instalar as dependências.
Configuração
Antes de poder usar a biblioteca, você precisará configurar suas chaves de acesso à API.
Configurando as chaves de acesso
A classe APIClient oferece dois métodos para configurar as chaves de acesso:
setApiKey(apiKey, [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:
setSecretApiKey(secretApiKey, [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:
Métodos de Ações
A classe APIClient fornece os seguintes métodos para interagir com as APIs:
get(path, [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:
getWithPagination(path, [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:
post(path, 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:
put(path, 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:
delete(path)
Realiza uma solicitação DELETE para o caminho especificado.
path(string): O caminho da API para a solicitação. Exemplo:
Exemplo de Uso
Aqui está um exemplo de código que demonstra o uso da biblioteca:
Lembre-se de substituir {api_address} pelo endereço real da API e {version} pela versão específica da API que você está usando. Além disso, substitua SUA_API_KEY e SUA_SECRET_API_KEY pelas suas chaves de acesso válidas.
Contributing
Contributions are welcome! If you would like to contribute to the PedroQuezado Api-Loader, feel free to open an issue or submit a pull request. We appreciate your feedback and contributions to make this project even better.
License This project is licensed under the MIT License.
