PHPackages                             medeirosdev/arquivei-nfe - 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. medeirosdev/arquivei-nfe

ActiveLibrary[Utility & Helpers](/categories/utility)

medeirosdev/arquivei-nfe
========================

Arquivei NFe Getter

1.0.9(6y ago)26MITPHPPHP ^7.3CI failing

Since Nov 12Pushed 6y ago1 watchersCompare

[ Source](https://github.com/MedeirosDev/arquivei-nfe)[ Packagist](https://packagist.org/packages/medeirosdev/arquivei-nfe)[ RSS](/packages/medeirosdev-arquivei-nfe/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (7)Versions (11)Used By (0)

PHP Arquivei NFe API
====================

[](#php-arquivei-nfe-api)

This is a simple package that allows access to the Arquivei NFe API.

Information
-----------

[](#information)

Package create for Arquivei NFe

Documentation -

Installation
------------

[](#installation)

Install the package using composer:

```
$ composer require medeirosdev/arquivei-nfe
```

Frameworks
----------

[](#frameworks)

At the moment we only have framework compatibility for Laravel. However, we welcome PRs to add further framework specific behavior as long as it doesn't prevent the package working for others

### Laravel

[](#laravel)

If you are using Laravel then you can use our service provider. If you have Laravel >5.5 then the package will be auto discovered upon install. Else, add the following to your `config/app.php` file:

```
'providers' => [
    ...
    \MedeirosDev\Arquivei\Frameworks\Laravel\ArquiveiServiceProvider::class,
]
```

#### Facades

[](#facades)

If you are using Laravel >5.5 then the facade will be automatically discovered. Else, you can add it in your `config/app.php` file.

```
'aliases' => [
    ...
    'Arquivei' => \MedeirosDev\Arquivei\Frameworks\Laravel\Arquivei::class,
]
```

#### Configuration

[](#configuration)

First, make sure you have copied the configuration file:

```
$ php artisan vendor:publish --tag=config --provider="MedeirosDev\Arquivei\Frameworks\Laravel\ArquiveiServiceProvider"

```

This will make a `config/arquivei.php` file, this is where your API Key / License information is fetched from. By default we use the `.env` configuration values to get your API key.

Use the App ID and App Code then you should add the following to your `.env`:

```
ARQUIVEI_BASE_URL=MY-BASE-URL
ARQUIVEI_VERSION=MY-API-VERSION
ARQUIVEI_API_ID=MY-API-ID
ARQUIVEI_API_KEY=MY-API-KEY

```

Please, make sure you don't store your keys in version control!

Usage
-----

[](#usage)

#### License / API Key

[](#license--api-key)

Before making requests you need to create your License object. You will need is your API key, then you can create your license as follows:

```
$license = new License($apiId, $apiKey);
```

Then, you can start making your request:

```
$arquivei = new Arquivei;
$arquivei->setLicense($license);

// or Laravel framework license is auto generated

$request = new Arquivei;
```

#### Basic usage

[](#basic-usage)

```
$page = 0;

$response = (new Arquivei)
            ->setLicense($license)
            ->request($page);

// Get data with list NFe
$response->data

// Or key access_key for first NFe
$response->data[0]->access_key
```

#### Basic usage in Laravel

[](#basic-usage-in-laravel)

##### No need to enter license object

[](#no-need-to-enter-license-object)

```
$response = (new Arquivei)->request();
```

#### Supported Method

[](#supported-method)

request

```
$arquivei = new Arquivei;
$response = $arquivei->request();
```

parse(int $cursor = 0)

```
$arquivei = new Arquivei;
$cursor = 0;
$response = $arquivei->request($cursor);
$listNfe = $arquivei->parse($response);
```

store(XmlParser ...$listNfe)

```
// Example Store implementing StoreInterface
class MyStore implements StoreInterface {
    public function store (XmlParser $nfe): bool
    {
        Storage::disk('local')->put($nfe->accessKey . '.xml', $nfe->xml);
        return true;
    }
}
```

```
$arquivei = new Arquivei;
$response = $arquivei->request();
$listNfe = $arquivei->parse($response);

$arquivei->setStore(new MyStore());
$store = $arquivei->store(...$ListNfe)
```

store(XmlParser ...$listNfe)

```
$arquivei = new Arquivei(new MyStore());
$response = $arquivei->request();
$listNfe = $arquivei->parse($response);

$store = $arquivei->store(...$ListNfe)
```

requestAll

```
$arquivei = new Arquivei;
$responses = $arquivei->requestAll();
```

requestAllAndStore

```
$arquivei = new Arquivei(new MyStore());
$responses = $arquivei->requestAllAndStore();
```

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 71.4% 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

10

Last Release

2368d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/11270546?v=4)[Flávio Medeiros](/maintainers/medeiroz)[@medeiroz](https://github.com/medeiroz)

---

Top Contributors

[![medeirozFer](https://avatars.githubusercontent.com/u/107270273?v=4)](https://github.com/medeirozFer "medeirozFer (10 commits)")[![medeiroz](https://avatars.githubusercontent.com/u/11270546?v=4)](https://github.com/medeiroz "medeiroz (4 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/medeirosdev-arquivei-nfe/health.svg)

```
[![Health](https://phpackages.com/badges/medeirosdev-arquivei-nfe/health.svg)](https://phpackages.com/packages/medeirosdev-arquivei-nfe)
```

###  Alternatives

[illuminate/cookie

The Illuminate Cookie package.

224.3M120](/packages/illuminate-cookie)[ralphjsmit/laravel-helpers

A package containing handy helpers for your Laravel-application.

13704.6k2](/packages/ralphjsmit-laravel-helpers)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

255.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)