README

API REST de serviços do Portal Nacional de Contratações Públicas (PNCP)

For more information, please visit https://www.serpro.gov.br.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/SHJordan/api-pncp-php.git"
    }
  ],
  "require": {
    "shjordan/api-pncp-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new OpenAPI\Client\Api\AtaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$cnpj = 'cnpj_example'; // string
$ano = 56; // int
$sequencial = 56; // int
$sequencial_ata = 56; // int
$pagina = 56; // int
$tamanho_pagina = 56; // int

try {
    $result = $apiInstance->consultarHistoricoAta($cnpj, $ano, $sequencial, $sequencial_ata, $pagina, $tamanho_pagina);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AtaApi->consultarHistoricoAta: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://treina.pncp.gov.br/api/pncp

Models

• AlterarCompraDTO
• AlterarCompraItemDTO
• AlterarCompraItemParcialDTO
• AlterarCompraItemResultadoDTO
• AlterarCompraParcialDTO
• AlterarContratoDTO
• AlterarTermoContratoDTO
• AlterarUnidadeOrgaoDTO
• AlterarUsuarioDTO
• AmparoLegal
• AtaRegistroPreco
• AtaRegistroPrecoAlteracaoDTO
• AtaRegistroPrecoDTO
• AtaRegistroPrecoInclusaoDTO
• CamposLoginDTO
• Categoria
• Compra
• CredenciaisDTO
• EnteCredenciaisDTO
• ErroValidacaoDTO
• ExclusaoDTO
• ExclusaoItemPcaDTO
• ExclusaoListaItensPcaDTO
• Get400Response
• IRecuperarPlanoItemDTO
• IncluirCompraItemDTO
• IncluirCompraItemResultadoDTO
• IncluirContratoDTO
• IncluirCredenciamentoDTO
• IncluirCredenciamentoResponsavelDTO
• IncluirOrgaoDTO
• IncluirPlanoContratacaoDTO
• IncluirPlanoContratacaoItemDTO
• IncluirTermoContratoDTO
• IncluirUnidadeOrgaoDTO
• IncluirUsuarioOrgaoDTO
• InserirUsuarioDTO
• Municipio
• OrgaoConsultaDTO
• OrgaoEntidade
• OrgaoEntidadeDTO
• PaginaRetornoAtaRegistroPrecoDTO
• PaginaRetornoRecuperarContratoDTO
• PlanoContratacaoComItensDTO
• PlanoContratacaoItemOrgaoToDTO
• PlanoContratacaoOrgaoDTO
• PlanoSequencialConsolidadoDTO
• RecuperarAmparoLegalDTO
• RecuperarAtaRegistroPrecoDTO
• RecuperarCompraDTO
• RecuperarCompraItemResultadoDTO
• RecuperarCompraItemSigiloDTO
• RecuperarContratoDTO
• RecuperarCredenciamentoDTO
• RecuperarCredenciamentoResponsavelDTO
• RecuperarCredenciamentoUsuarioDTO
• RecuperarDadosDocumentoAtaDTO
• RecuperarDadosDocumentoCompraDTO
• RecuperarDadosDocumentoContratoDTO
• RecuperarDadosDocumentoTermoContratoDTO
• RecuperarFornecedorDTO
• RecuperarHistoricoAtaDTO
• RecuperarHistoricoCompraDTO
• RecuperarHistoricoContratoDTO
• RecuperarImagemContratacaoItemDTO
• RecuperarOrgaoEntidadeDTO
• RecuperarTermoContratoDTO
• RecuperarTokenLoginUnicoDTO
• RecuperarUnidadeOrgaoDTO
• RecuperarValoresCategoriaItemPcaDTO
• RespostaErroValidacaoDTO
• RetificarParcialCredenciamentoDTO
• RetificarParcialPlanoContratacaoItemDTO
• RetificarParcialPlanoContratacaoListaItensDTO
• SequenciaisDTO
• TipoContrato
• UF
• UnidadeOrgao
• UnidadeOrgaoDTO

Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

css.serpro@serpro.gov.br

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen