PHPackages                             paseto/atm-api-rest - 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. [API Development](/categories/api)
4. /
5. paseto/atm-api-rest

ActiveLibrary[API Development](/categories/api)

paseto/atm-api-rest
===================

Api for AT&M Averba - REST

v0.5(4d ago)1352↓87.5%MITPHPPHP ^8.1CI failing

Since Jul 24Pushed 2y agoCompare

[ Source](https://github.com/paseto/atm-api-rest)[ Packagist](https://packagist.org/packages/paseto/atm-api-rest)[ RSS](/packages/paseto-atm-api-rest/feed)WikiDiscussions master Synced today

READMEChangelog (7)Dependencies (8)Versions (8)Used By (0)

ATM API REST
============

[](#atm-api-rest)

Integração Web Service 2.0 - REST

[![Latest Version on Packagist](https://camo.githubusercontent.com/7f2fc88e372d3cd4678f1c2f800a6f32fb1c0dde98799b0b4177c7bea6b4bea3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f70617365746f2f61746d2d6170692d726573742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/paseto/atm-api-rest)[![Total Downloads](https://camo.githubusercontent.com/de958581e53ed1dc93a9b7bc9dbadd6da095cbdfeac4666a7df5b1ec0ffe689a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f70617365746f2f61746d2d6170692d726573742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/paseto/atm-api-rest)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)

How To
------

[](#how-to)

Verificar pasta `examples` com um exemplo prático.

### Ambiente

[](#ambiente)

Por padrão, a biblioteca usa produção em `https://webserver.averba.com.br/rest/`.

Para homologação, use o construtor com `HOMOLOG_BASE_URI` e credenciais/código ATM de teste fornecidos pelo suporte AT&M:

```
$averba = new \Paseto\ATMAverbaRest(null, \Paseto\ATMAverbaRest::HOMOLOG_BASE_URI);
```

Produção e homologação utilizam o mesmo endereço do webservice; a distinção é feita pelas credenciais. O manual v1.1 (§27.9) cita `homologaws.averba.com.br`, porém a AT&M orienta usar `webserver.averba.com.br` para ambos os ambientes.

### Validar credenciais

[](#validar-credenciais)

```
if ($averba->validateCredentials()) {
    echo $averba->getResultStatusMessage();
} else {
    print_r($averba->getErrors());
}
```

### Métodos disponíveis

[](#métodos-disponíveis)

MétodoEndpointXML esperado`averbaCTe()``/rest/Cte`CT-e protocolado`cancelaCTe()``/rest/Cte`CT-e cancelado protocolado`averbaMDFe()``/rest/MDFe`MDF-e protocolado`encerraMDFe()``/rest/MDFe`MDF-e encerrado`cancelaMDFe()``/rest/MDFe`MDF-e cancelado`incluiCondutorMDFe()``/rest/MDFe`MDF-e inclusão de condutor`averbaOutroDocumento()``/rest/Cte`Monta XML layout AT&M (seção 14)Todos os métodos de documento com arquivo exigem `setXml()` antes da chamada, exceto `averbaOutroDocumento()`, que recebe um `OutroDocumento`.

### Outros documentos (layout AT&M)

[](#outros-documentos-layout-atm)

```
$documento = (new \Paseto\OutroDocumento())
    ->setMod(\Paseto\OutroDocumento::MOD_CTRC) // 99=CTRC, 98=NFSe, 97=Ordem Coleta...
    ->setSerie('1')
    ->setNCT('123456')
    ->setDhEmi('2024-06-15T10:30:00')
    ->setCMunIni('3550308')->setUFIni('SP')
    ->setCMunFim('3304557')->setUFFim('RJ')
    ->setEmit(new \Paseto\OutroDocumentoParte('07715207000191', '3550308', 'SP'))
    ->setRem(new \Paseto\OutroDocumentoParte('07715207000191', '3550308', 'SP', '1058'))
    ->setDest(new \Paseto\OutroDocumentoParte('00000000000191', '3304557', 'RJ', '1058'))
    ->setVCarga('1500.00')
    ->setVCargaSeguro('1500.00');

if ($averba->averbaOutroDocumento($documento)) {
    echo $averba->getResultProtocol();
}
```

Return
------

[](#return)

Método `getResultStatus()` - (bool) Status da solicitação

#### Case return True or False

[](#case-return-true-or-false)

Método `getResultStatusCode()` - (int) Código da resposta da solicitação webservice (pode haver mais de uma, utilizar método `getResponse()` para exibir todas)

Método `getResultStatusMessage()` - (string) Descrição da resposta da solicitação webservice

Método `getResponse()` - (object) Todos os detalhes do retorno

#### True Only

[](#true-only)

Método `getResultProtocol()` - (string) Número do protocolo da averbação

Método `getResultProtocolDate()` - (string datetime Y-m-dTH:i:s) Data e hora do protocolo da averbação

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance55

Moderate activity, may be stable

Popularity16

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~361 days

Recently: every ~541 days

Total

7

Last Release

4d ago

PHP version history (2 changes)v0.1PHP ^7.2

v0.4PHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/4ea689b9912df39e779b2aef84da7c87f6deeeb9f376016109036a3d1821f139?d=identicon)[paseto](/maintainers/paseto)

---

Top Contributors

[![paseto](https://avatars.githubusercontent.com/u/1163778?v=4)](https://github.com/paseto "paseto (8 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/paseto-atm-api-rest/health.svg)

```
[![Health](https://phpackages.com/badges/paseto-atm-api-rest/health.svg)](https://phpackages.com/packages/paseto-atm-api-rest)
```

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.8k3.6M984](/packages/statamic-cms)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M47](/packages/tencentcloud-tencentcloud-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k38](/packages/neuron-core-neuron-ai)[avalara/avataxclient

Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API.

528.5M7](/packages/avalara-avataxclient)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)

PHPackages © 2026

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