Download the PHP package tagplus/sdk-api-php without Composer
On this page you can find all versions of the php package tagplus/sdk-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tagplus/sdk-api-php
More information about tagplus/sdk-api-php
Files in tagplus/sdk-api-php
Package sdk-api-php
Short Description Um cliente PHP para consumir a API do ERP TagPlus.
License
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 sdk-api-php
SDK PHP TagPlus
A SDK facilita a integração com a nossa API do ERP, principalmente nas etapas de autenticação.
Requisitos
- PHP >= 5.4
- Composer
Preparando
Vamos instalar a SDK via Composer:
Como usar
IMPORTANTE: Para prosseguir você já precisa ter se registrado no portal da API e ter disponível seu client_id, client_secret e redirect_uri. Caso ainda não tenha se registrado acesse aqui e clique em Cadastrar.
A API utiliza o OAuth2 para autenticação, vamos mostrar um exemplo de como você deve utilizar a SDK para efetuar a autenticação. Confira nossa documentação de API aqui.
1. Autorização do usuário
O primeiro passo é redirecionar o usuário para o TagPlus, para que assim ele possa autorizar sua aplicação. Normalmente é um link em determinado pedaço da sua página web.
Ao clicar no link o usuário poderá autorizar (ou não) a sua aplicação a acessar os recursos solicitados (scope).
2. Receber o código e recuperar token
Como término do passo anterior o usuário será redirecionado para a url cadastrada no portal (redirect_uri).
Nesse página de retorno (callback) você deve ter os seguintes trechos de código:
O trecho de código acima vai recuperar um access token válido e salvá-lo no arquivo cujo nome foi passado ao criar a classe FileTokenPersistence.
3. Acessando API
Agora já está tudo pronto para utilizar a API:
Esse foi apenas um exemplo de como usar a API do ERP TagPlus. Para mais detalhes de quais recursos estão disponíveis acesse nossa referência.
Próximos passos
- [ ] Explicar como armazenar os tokens no BD (ex.: MySQL);
- [ ] Explicar como usar a SDK junto com uma framework (ex.: Laravel, CodeIgniter, Symfony, etc...);
- [ ] Recuperar todas as páginas (quando houver) automaticamente;
- [ ] Já retornar a instância do Objeto, sem precisar chamar a função json_decode;
- [ ] Ter métodos para todos os recursos, ao invés de passar a URL como parâmetro (ex.:
$api->getClientes()).
All versions of sdk-api-php with dependencies
guzzlehttp/guzzle Version ^5
kamermans/guzzle-oauth2-subscriber Version ^1