Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FiscalAPI — SDK PHP

Cliente PHP da [FiscalAPI](https://fiscalapi.com.br): Inscrição Estadual nos 27 estados, CNPJ, certidões (CND estadual, CND Federal, CNDT, CRF/FGTS), XML de NF-e por chave, NFS-e por chave, Simples Nacional, SIGEF, CNIR e perfil do produtor rural.
Cliente PHP da [FiscalAPI](https://fiscalapi.com.br): Inscrição Estadual nos 27 estados, CNPJ, certidões (CND estadual, CND Federal, CNDT, CRF/FGTS), XML de NF-e e de CT-e por chave, NFS-e por chave, Simples Nacional, SIGEF, CNIR e perfil do produtor rural.

- PHP 8.1 ou superior, só com a extensão `curl` (nenhum pacote do Composer).
- Autoload PSR-4 (`FiscalApiBr\`).
Expand Down Expand Up @@ -53,6 +53,7 @@ Todos os métodos devolvem `array` com o JSON da API. Use argumentos nomeados pa
| `consultarSimplesNacional($cnpj)` | `GET /api/consultar-simples-nacional` | Situação no Simples Nacional e SIMEI |
| `consultarNfse($chave, danfse: false)` | `GET /api/consultar-nfse` | NFS-e (padrão nacional) por chave, sem certificado |
| `consultarNfeXml($chave, $certificado, $senha, manifestar: true)` | `POST /api/consultar-nfe-xml` | XML completo da NF-e |
| `consultarCteXml($chave, $certificado, $senha)` | `POST /api/consultar-cte-xml` | XML completo do CT-e |
| `consultarSigef(cpf: \| cnpj:)` | `GET /api/consultar-sigef` | Parcelas certificadas no SIGEF/INCRA |
| `consultarSigefParcela($uuid, forceFresh: false)` | `GET /api/consultar-sigef-parcela` | Uma parcela com polígono, vértices e confrontantes |
| `consultarCnir(cpf: \| cnpj:)` | `GET /api/consultar-cnir` | Imóveis rurais no CNIR/CAFIR |
Expand Down Expand Up @@ -139,6 +140,23 @@ if ($nota['status'] === 'ok') {

O certificado A1 precisa ser de um participante da nota (emitente, destinatário, transportador ou autorizado) e **não é armazenado** pela API. Só há cobrança quando o XML é devolvido.

### XML de CT-e por chave

```php
$cte = $api->consultarCteXml(
'51261011222333000181570010000001231123456784',
'certificado.pfx', // caminho do arquivo ou conteúdo em base64
'senha-do-certificado',
);
if ($cte['status'] === 'ok') {
file_put_contents($cte['chave'] . '.xml', $cte['xml']);
} else {
echo $cte['status'], ': ', $cte['mensagem'], PHP_EOL;
}
```

Aceita CT-e (modelo 57), CT-e OS (67) e GTV-e (64). O certificado A1 precisa ser de um participante do documento (emitente, tomador, remetente, destinatário, expedidor ou recebedor) e **não é armazenado** pela API. Só há cobrança quando o XML é devolvido.

### Imóvel rural

```php
Expand Down
23 changes: 22 additions & 1 deletion src/FiscalAPI.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*/
final class FiscalAPI
{
public const VERSION = '0.2.0';
public const VERSION = '0.3.0';
public const DEFAULT_BASE_URL = 'https://api.fiscalapi.com.br';
/** Algumas consultas (NF-e, SIGEF) podem levar até 180 s no servidor. */
public const DEFAULT_TIMEOUT = 200;
Expand Down Expand Up @@ -195,6 +195,27 @@ public function consultarNfeXml(string $chave, string $certificado, string $senh
]);
}

/**
* XML completo de um CT-e, CT-e OS ou GTV-e pela chave de acesso (POST /api/consultar-cte-xml).
*
* @param string $chave Chave de acesso com 44 dígitos.
* @param string $certificado Caminho do arquivo .pfx/.p12 ou o conteúdo em base64.
* O certificado não é armazenado pela API.
* @param string $senha Senha do certificado.
*/
public function consultarCteXml(string $chave, string $certificado, string $senha): array
{
if (trim($chave) === '') {
throw new \InvalidArgumentException('Informe a chave de acesso.');
}
return $this->request('POST', '/api/consultar-cte-xml', [], [
// Aceita CNPJ alfanumérico: só tira separadores e põe em maiúsculas.
'chave' => strtoupper(preg_replace('/[^0-9A-Za-z]/', '', $chave) ?? ''),
'certificado' => self::certificadoBase64($certificado),
'senha' => $senha,
]);
}

/**
* NFS-e (padrão nacional) pela chave de acesso, sem certificado
* (GET /api/consultar-nfse). Com $danfse = true, inclui o PDF do DANFSe em
Expand Down
Loading