Skip to content

SHJordan/api-pncp-php

Repository files navigation

OpenAPIClient-php

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

Class Method HTTP request Description
AtaApi consultarHistoricoAta GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/atas/{sequencialAta}/historico Consultar Histórico de Ata
AtaApi consultarHistoricoAtaQuantidade GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/atas/{sequencialAta}/historico/quantidade Consultar Quantidade Histórico de Ata
AtaApi deleteAta DELETE /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas/{sequencialAta} Excluir Ata de Registro de Preço
AtaApi deleteDocumentoAta DELETE /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas/{sequencialAta}/arquivos/{sequencialDocumento} Excluir Documento de Ata de Registro de Preço
AtaApi inserirArquivo3 POST /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas/{sequencialAta}/arquivos Inserir Documento em Ata de Registro de Preço
AtaApi inserirAta POST /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas Inserir Ata de Registro de Preço
AtaApi recuperarArquivo3 GET /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas/{sequencialAta}/arquivos/{sequencialDocumento} Recuperar Documento de Ata de Registro de Preço
AtaApi recuperarAtaDocumentoQuantidade GET /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas/{sequencialAta}/arquivos/quantidade Consultar Quantidade de Documentos de Ata
AtaApi recuperarAtaRegistoPreco GET /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas/{sequencialAta} Consultar Ata de Registro de Preço
AtaApi recuperarAtasPorFiltros GET /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas Consultar Atas de Registro de Preço por Compra
AtaApi recuperarInformacoesDocumentosAta GET /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas/{sequencialAta}/arquivos Consultar Dados de Todos os Documentos de uma Ata de Registro de Preço
AtaApi retificarAta PUT /v1/orgaos/{cnpj}/compras/{anoCompra}/{sequencialCompra}/atas/{sequencialAta} Retificar Ata de Registro de Preço
ContrataoApi consultarCompra GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial} Consultar Contratação
ContrataoApi consultarCompra1 GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/historico Consultar Histórico de Contratação
ContrataoApi consultarQuantidade GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/historico/quantidade Consultar Quantidade Histórico de Contratação
ContrataoApi getImagem GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem}/imagem/{sequencialImagem} Recuperar Imagem de um Item de uma Contratação
ContrataoApi getImagemLista GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem}/imagem Recuperar Imagens de um Item de uma Contratação
ContrataoApi incluirCompra POST /v1/orgaos/{cnpj}/compras Inserir Contratação
ContrataoApi incluirCompraItem POST /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens Inserir Item de Contratação
ContrataoApi incluirCompraItemResultado POST /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem}/resultados Inserir Resultado de Item de Contratação
ContrataoApi inserirArquivo2 POST /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/arquivos Inserir Documento de Contratação
ContrataoApi inserirImagem POST /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem}/imagem Inserir Imagem de um Item de Contratação
ContrataoApi pesquisarCompraItem GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens Consultar Todos os Itens de Contratação
ContrataoApi recuperarArquivo2 GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/arquivos/{sequencialDocumento} Baixar Documento de Contratação
ContrataoApi recuperarCompraDocumentoQuantidade GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/arquivos/quantidade Consultar Quantidade de Documentos de Contratação
ContrataoApi recuperarCompraItem GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem} Consultar Item de Contratação
ContrataoApi recuperarCompraItemQuantidade GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/quantidade Consultar Quantidade Item de Contratação
ContrataoApi recuperarInformacoesDocumentosCompra GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/arquivos Consultar Documentos de Contratação
ContrataoApi recuperarResultado GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem}/resultados/{sequencialResultado} Consultar Resultado de Item de Contratação
ContrataoApi recuperarResultados GET /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem}/resultados Consultar Resultados de Item de Contratação
ContrataoApi removerCompra DELETE /v1/orgaos/{cnpj}/compras/{ano}/{sequencial} Excluir Contratação
ContrataoApi removerDocumentoCompra DELETE /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/arquivos/{sequencialDocumento} Excluir Documento de Contratação
ContrataoApi removerImagem DELETE /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem}/imagem/{sequencialImagem} Remover Imagem de um Item de uma Contratação
ContrataoApi retificarCompra PUT /v1/orgaos/{cnpj}/compras/{ano}/{sequencial} Retificar Contratação
ContrataoApi retificarCompraItem PUT /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem} Retificar Item de Contratação
ContrataoApi retificarCompraItemResultado PUT /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem}/resultados/{sequencialResultado} Retificar Resultado de Item de Contratação
ContrataoApi retificarParcialmenteCompra PATCH /v1/orgaos/{cnpj}/compras/{ano}/{sequencial} Retificar parcialmente uma Contratação
ContrataoApi retificarParcialmenteCompraItem PATCH /v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/itens/{numeroItem} Retificar Parcialmente um Item de Contratação
ContratoApi consultarContrato GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial} Consultar Contrato
ContratoApi consultarContrato1 GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/historico Consultar Histórico de Contrato
ContratoApi consultarContrato2 GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/historico/quantidade Consultar Quantidade Histórico de Contrato
ContratoApi consultarContratosContratacao GET /v1/orgaos/{cnpj}/contratos/contratacao/{anoContratacao}/{sequencialContratacao} Consultar Contratos de uma Contratação
ContratoApi inserirArquivo1 POST /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/arquivos Inserir Documento de Contrato
ContratoApi inserirContrato POST /v1/orgaos/{cnpj}/contratos Inserir Contrato
ContratoApi recuperarArquivo1 GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/arquivos/{sequencialDocumento} Baixar Documento de Contrato
ContratoApi recuperarContratoDocumentoQuantidade GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/arquivos/quantidade Consultar Quantidade de Documentos de Contrato
ContratoApi recuperarInformacoesDocumentosContrato GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/arquivos Consultar Documentos de Contrato
ContratoApi removerContrato DELETE /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial} Excluir Contrato
ContratoApi removerDocumentoContrato1 DELETE /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/arquivos/{sequencialDocumento} Excluir Documento de Contrato
ContratoApi retificarContrato PUT /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial} Retificar Contrato
CredenciamentoApi criarUsuarioCredenciamentoDeferido POST /v1/credenciamentos/{ano}/{sequencial}/criarUsuario Criar Usuário Credenciamento
CredenciamentoApi incluirCredenciamento POST /v1/credenciamentos Inserir Credencimento
CredenciamentoApi recuperarCredenciamento GET /v1/credenciamentos/{ano}/{sequencial} Consultar Credencimento
CredenciamentoApi recuperarCredenciamentoResponsavel GET /v1/credenciamentos/{ano}/{sequencial}/responsaveis Consultar Credencimento Responsavel
CredenciamentoApi recuperarCredenciamentos GET /v1/credenciamentos Consultar Credencimentos
CredenciamentoApi recuperarQuantidadeCredenciamentos GET /v1/credenciamentos/quantidade Consultar Quantidade Credencimentos
CredenciamentoApi retificarParcialmenteCredenciamento PATCH /v1/credenciamentos/{ano}/{sequencial} Retificar Parcialmente Credenciamento
LoginNicoApi recuperarToken POST /v1/login-unico/token Recuperar token
PlanoDeContrataoApi consultarPlanoComItens GET /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens/plano Consultar Plano de Contratação com Itens
PlanoDeContrataoApi consultarPlanoConsolidado GET /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/consolidado Consultar Plano de Contratação Consolidado
PlanoDeContrataoApi incluirPlano POST /v1/orgaos/{cnpj}/pca Inserir Plano de Contratação
PlanoDeContrataoApi incluirPlanoContratacaoItem POST /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens Inserir itens de Plano de Contratação
PlanoDeContrataoApi recuperarDadosOrgaoPca GET /v1/orgaos/{cnpj}/pca/{ano}/consolidado Consultar Planos de Contratação Consolidados por Órgão e Ano
PlanoDeContrataoApi recuperarDadosOrgaoPcaQuantidade GET /v1/orgaos/{cnpj}/pca/{ano}/quantidade Consultar Quantidade de Planos de Contratação
PlanoDeContrataoApi recuperarDadosOrgaoPcaUnidades GET /v1/orgaos/{cnpj}/pca/{ano}/consolidado/unidades Consultar Planos de Contratação Consolidados das Unidades por Órgão e Ano
PlanoDeContrataoApi recuperarDadosPcaItensCategoria GET /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens Consultar Itens do Plano de Contratação
PlanoDeContrataoApi recuperarDadosPcaItensQuantidadeItens GET /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens/quantidade Consultar Quantidade de Itens do Plano de Contratação
PlanoDeContrataoApi recuperarItensPlanoPorContratacao GET /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens/contratacao Retornar Itens de Plano de Contratação por número da Contratação
PlanoDeContrataoApi recuperarSequenciaisDoPlano GET /v1/orgaos/{cnpj}/pca/{uasg}/{ano}/sequenciaisplano
PlanoDeContrataoApi recuperarValoresCategoriaItem GET /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/valorescategoriaitem Consultar Valores de um Plano de Contratação por Categoria
PlanoDeContrataoApi recuperarValoresCategoriaItem1 GET /v1/orgaos/{cnpj}/pca/{ano}/valorescategoriaitem Consultar Valores de Planos de Contratação de um Órgão por Categoria
PlanoDeContrataoApi removerItemPlano DELETE /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens/{numeroItem} Excluir Item de Plano de Contratação
PlanoDeContrataoApi removerItensPlano DELETE /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens Excluir Itens de Plano de Contratação
PlanoDeContrataoApi removerItensPlanoPorContratacao DELETE /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens/contratacao Excluir Itens de Plano de Contratação por número da Contratação
PlanoDeContrataoApi removerPlano DELETE /v1/orgaos/{cnpj}/pca/{ano}/{sequencial} Excluir Plano de Contratação
PlanoDeContrataoApi retificarParcialmentePlanoContratacaoItem PATCH /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens/{numeroItem} Retificar Parcialmente item de Plano de Contratação
PlanoDeContrataoApi retificarParcialmentePlanoContratacaoItens PATCH /v1/orgaos/{cnpj}/pca/{ano}/{sequencial}/itens Retificar Parcialmente itens de Plano de Contratação
PlanoDeContrataoApi retornarPlanosTodasUnidadesDoOrgaoCsv GET /v1/orgaos/{cnpj}/pca/{ano}/csv Baixar CSV dos Planos de Contratação por Órgão e Ano
RgoApi consultarEntesPorFiltro GET /v1/orgaos/ Consultar Órgão por Filtro
RgoApi postEnteGoverno POST /v1/orgaos Inserir Órgão
RgoApi putEnteGoverno PUT /v1/orgaos Atualizar Órgão
RgoApi recuperarEnte GET /v1/orgaos/{cnpj} Consultar Órgão por CNPJ
RgoApi recuperarEnte1 GET /v1/orgaos/id/{orgaoId} Consultar Órgão por ID
TermoDeContratoApi inserirArquivo POST /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/{sequencialTermo}/arquivos Inserir Documento de Termo de Contrato
TermoDeContratoApi inserirTermoContrato POST /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos Inserir Termo de Contrato
TermoDeContratoApi recuperarArquivo GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/{sequencialTermo}/arquivos/{sequencialDocumento} Baixar Documento de Termo de Contrato
TermoDeContratoApi recuperarInformacoesDocumentosTermoContrato GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/{sequencialTermo}/arquivos Consultar Documentos de Termo de Contrato
TermoDeContratoApi recuperarQuantidadeDocumentosTermoContrato GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/{sequencialTermo}/arquivos/quantidade Consultar Quantidade de Documentos de Termo de Contrato
TermoDeContratoApi recuperarQuantidadeTermosContrato GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/quantidade Consultar Quantidade de Termos de Contrato
TermoDeContratoApi recuperarTermoContrato GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/{sequencialTermoContrato} Consultar Termo de Contrato
TermoDeContratoApi recuperarTermosContrato GET /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos Consultar Termos de Contrato
TermoDeContratoApi removerContrato1 DELETE /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/{sequencialTermoContrato} Excluir Termo de Contrato
TermoDeContratoApi removerDocumentoContrato DELETE /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/{sequencialTermo}/arquivos/{sequencialDocumento} Excluir Documento de Termo de Contrato
TermoDeContratoApi retificarTermoContrato PUT /v1/orgaos/{cnpj}/contratos/{ano}/{sequencial}/termos/{sequencialTermoContrato} Retificar Termo de Contrato
UnidadeApi atualizarUnidadeOrgao PUT /v1/orgaos/{cnpj}/unidades Atualizar Unidade
UnidadeApi recuperarUnidadeOrgao GET /v1/orgaos/{cnpj}/unidades/{codigoUnidade} Consultar Unidade
UnidadeApi recuperarUnidadesOrgao GET /v1/orgaos/{cnpj}/unidades Consultar Unidades
UnidadeApi salvarUnidadeOrgao POST /v1/orgaos/{cnpj}/unidades Inserir Unidade
UsurioApi autenticar POST /v1/usuarios/login Autenticação/login no sistema
UsurioApi delete DELETE /v1/usuarios/{id} Excluir usuário
UsurioApi delete1 DELETE /v1/usuarios/{id}/orgaos Excluir Entes Autorizados de um Usuário
UsurioApi get GET /v1/usuarios/{id} Consultar usuário por ID
UsurioApi getByLoginNi GET /v1/usuarios Consultar usuário por login ou por CPF/CNPJ
UsurioApi post POST /v1/usuarios Inserir usuário
UsurioApi post1 POST /v1/usuarios/{id}/orgaos Inserir Entes Autorizados para um Usuário
UsurioApi put PUT /v1/usuarios/{id} Atualizar usuário

Models

Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

[email protected]

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages