Download the PHP package compufacil/api-sdk without Composer

On this page you can find all versions of the php package compufacil/api-sdk. 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 compufacil/api-sdk

Informations about the package api-sdk

Instalação SDK

O Compufácil PHP SDK tem como dependência de instalação o composer. Execute o seguinte comando:

composer require compufacil/api-sdk

Integrando a API da CompuFácil via SDK PHP

A API da CompuFácil segue o padrão RPC. E o tráfego de dados é através de JSON.

Ambientes

Existem dois ambiente servindo a API. O ambiente de homologação e de produção.

Padrão dos serviços

Todos os serviços seguem a seguinte nomenclatura:

Módulo e serviço variam de acordo com o que parte do sistema está sendo utilizada.

Exemplo:

Autenticação

Primeiramente instanciamos a classe passando as configurações do ambiente e a versão, se caso não passarmos ela pegara os valores default que sempre será ambiente de homolog e a última versão estável da API.

seguindo a autenticação se dá através da função signUp:

Na resposta de uma autenticação com sucesso conterá o token que dever ser trafegado nas requisições autenticadas.

Enquanto mantivermos a classe o token ficara armazenado no estado da mesma

Serviços

Os demais serviços seguem o mesmo padrão da autenticação, com a única diferença que trafegam o token no header Authorization-Compufacil e utilizamos agora a função auxiliar rpcService

Exemplo fazendo o CRUD de receitas

Lista receitas

Cria receita

Pega 1 receita detalhada

Atualiza uma receita

Deleta receita

Swagger

Para uma referência completa dos serviços você pode consultar o nosso swager . Lá também é possível executar os serviços diretamente contra homolog.

Nosso blog

Contato

Qualquer dúvida sobre a API entre em contato com nosso time técnico. Através do e-mail [email protected].

All versions of api-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^7.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 compufacil/api-sdk contains the following files

Loading the files please wait ....