chico-rei/gollog-api

Autogenerated Swagger

v0.3.0 2020-02-26 19:56 UTC

This package is auto-updated.

Last update: 2022-07-27 01:22:49 UTC


README

De maneira pratica e rápida, entenda como conectar e consumir todas as informações necessárias para seu negócio.

Ambientes

Os ambientes do gateway de integração são divididos atualmente em 2 ambientes:
     QA: ambiente utilizado para desenvolvimento de novas integrações e testes com os clientes e parceiros.
   Prod: ambiente de produção com todas os serviços expostos com certificação de qualidade.

Informações Adicionais

A central do desenvolvedor conta com uma completa documentação referente a todos os APIs expostos, com exemplos de request/response, modelo e possibilidade de realizar testes direto no barramento.

Atualmente nossa central está separada com 2 dominios de integração:
    - Account
         Serviços para autenticação quando necessário.
    - Sales
         Disponibilização de serviços para utilização de rastreio, cotações, minutas e documentos autorizados.
    - Operations
         Disponibilização de consulta de bases operacionais.
(*)Dependendo do endpoint utilizado, algumas informações são obrigatórias, como identificador da aplicação/cliente e token.

Dúvidas sobre como utilizar, entre em contato br-operations@ttinteractive.com

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: V1
  • Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit http://www.ttinteractive.com

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$apiInstance = new Swagger\Client\Api\AccountApi(
    // 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()
);
$company_key = "company_key_example"; // string | IATA company code \"example G1\"
$model = new \Swagger\Client\Model\Model(); // \Swagger\Client\Model\Model | Sigin model with login information

try {
    $result = $apiInstance->accountSignIn($company_key, $model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountSignIn: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost/api

Class Method HTTP request Description
AccountApi accountSignIn POST /account/signin Log user into the system
AccountApi accountSignOut POST /account/signout Log out current logged in user session
OperationsApi operationsPoints GET /operations/points/ Return operational points
SalesApi quotationCalculateQuotation POST /sales/transportorder/quotation Retun a freight quotation based on parameters
SalesApi salesTransportorderCancelPost POST /sales/transportorder/cancel Cancel a booking.
SalesApi salesTransportorderDacteDocumentNumberGet GET /sales/transportorder/dacte/{documentNumber} Get a transport order DACTE by document number
SalesApi salesTransportorderMinutePost POST /sales/transportorder/minute Create a freight book based on parameters.
SalesApi salesTransportorderTrackingCustomerdocumentPost POST /sales/transportorder/tracking/customerdocument Return last action from transport orders what had status change in the last 3 days by customer document number
SalesApi trackingTrackTransportOrder POST /sales/transportorder/tracking Return all transport order tracking events
SalesApi xmlTransportOrder POST /sales/transportorder/xml Return a CTe XML string by Document Number and Customer Document

Documentation For Models

Documentation For Authorization

basic

  • Type: HTTP basic authentication

Author