Phoenix (TMS) - API

Autenticacao

autenticacao

auth

Autenticação via JWT, utilizar token gerado no header de cada solicitacao! chave Authorization, value Bearer {token}


/oauth/token

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/x-www-form-urlencoded"\
"https://phoenixapi.moovelogistica.pt/phoenixapi/oauth/token"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutenticacaoApi;

import java.io.File;
import java.util.*;

public class AutenticacaoApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        AutenticacaoApi apiInstance = new AutenticacaoApi();
        String client = client_example; // String | 
        String username = username_example; // String | 
        String password = password_example; // String | 
        String grantType = grantType_example; // String | 
        try {
            Token result = apiInstance.autenticacao(client, username, password, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutenticacaoApi#autenticacao");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AutenticacaoApi;

public class AutenticacaoApiExample {

    public static void main(String[] args) {
        AutenticacaoApi apiInstance = new AutenticacaoApi();
        String client = client_example; // String | 
        String username = username_example; // String | 
        String password = password_example; // String | 
        String grantType = grantType_example; // String | 
        try {
            Token result = apiInstance.autenticacao(client, username, password, grantType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutenticacaoApi#autenticacao");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *client = client_example; //  (optional)
String *username = username_example; //  (optional)
String *password = password_example; //  (optional)
String *grantType = grantType_example; //  (optional)

AutenticacaoApi *apiInstance = [[AutenticacaoApi alloc] init];

// auth
[apiInstance autenticacaoWith:client
    username:username
    password:password
    grantType:grantType
              completionHandler: ^(Token output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PhoenixTmsApi = require('phoenix__tms___api');
var defaultClient = PhoenixTmsApi.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new PhoenixTmsApi.AutenticacaoApi()
var opts = { 
  'client': client_example // {{String}} 
  'username': username_example // {{String}} 
  'password': password_example // {{String}} 
  'grantType': grantType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.autenticacao(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class autenticacaoExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AutenticacaoApi();
            var client = client_example;  // String |  (optional) 
            var username = username_example;  // String |  (optional) 
            var password = password_example;  // String |  (optional) 
            var grantType = grantType_example;  // String |  (optional) 

            try
            {
                // auth
                Token result = apiInstance.autenticacao(client, username, password, grantType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutenticacaoApi.autenticacao: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiAutenticacaoApi();
$client = client_example; // String | 
$username = username_example; // String | 
$password = password_example; // String | 
$grantType = grantType_example; // String | 

try {
    $result = $api_instance->autenticacao($client, $username, $password, $grantType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutenticacaoApi->autenticacao: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutenticacaoApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AutenticacaoApi->new();
my $client = client_example; # String | 
my $username = username_example; # String | 
my $password = password_example; # String | 
my $grantType = grantType_example; # String | 

eval { 
    my $result = $api_instance->autenticacao(client => $client, username => $username, password => $password, grantType => $grantType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutenticacaoApi->autenticacao: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AutenticacaoApi()
client = client_example # String |  (optional)
username = username_example # String |  (optional)
password = password_example # String |  (optional)
grantType = grantType_example # String |  (optional)

try: 
    # auth
    api_response = api_instance.autenticacao(client=client, username=username, password=password, grantType=grantType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutenticacaoApi->autenticacao: %s\n" % e)

Parameters

Form parameters
Name Description
client
String
username
String
password
String
grant_type
String

Responses

Status: 200 - Autenticação realizada com sucesso.

Status: 400 - Usuario e senha invalidos.

Status: 500 - Erro interno no servidor.

PostagensTMS

cadastrarPostagem

Cadastro de postagem

API para cadastro de postagem no TMS


/postagem/nova

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://phoenixapi.moovelogistica.pt/phoenixapi/postagem/nova"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PostagensTMSApi;

import java.io.File;
import java.util.*;

public class PostagensTMSApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PostagensTMSApi apiInstance = new PostagensTMSApi();
        BodyCadastroPostagem body = ; // BodyCadastroPostagem | 
        try {
            ListaRetornoCadastroPostagem result = apiInstance.cadastrarPostagem(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PostagensTMSApi#cadastrarPostagem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PostagensTMSApi;

public class PostagensTMSApiExample {

    public static void main(String[] args) {
        PostagensTMSApi apiInstance = new PostagensTMSApi();
        BodyCadastroPostagem body = ; // BodyCadastroPostagem | 
        try {
            ListaRetornoCadastroPostagem result = apiInstance.cadastrarPostagem(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PostagensTMSApi#cadastrarPostagem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
BodyCadastroPostagem *body = ; // 

PostagensTMSApi *apiInstance = [[PostagensTMSApi alloc] init];

// Cadastro de postagem
[apiInstance cadastrarPostagemWith:body
              completionHandler: ^(ListaRetornoCadastroPostagem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PhoenixTmsApi = require('phoenix__tms___api');
var defaultClient = PhoenixTmsApi.ApiClient.instance;


var api = new PhoenixTmsApi.PostagensTMSApi()
var body = ; // {{BodyCadastroPostagem}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cadastrarPostagem(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cadastrarPostagemExample
    {
        public void main()
        {


            var apiInstance = new PostagensTMSApi();
            var body = new BodyCadastroPostagem(); // BodyCadastroPostagem | 

            try
            {
                // Cadastro de postagem
                ListaRetornoCadastroPostagem result = apiInstance.cadastrarPostagem(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PostagensTMSApi.cadastrarPostagem: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiPostagensTMSApi();
$body = ; // BodyCadastroPostagem | 

try {
    $result = $api_instance->cadastrarPostagem($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostagensTMSApi->cadastrarPostagem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PostagensTMSApi;


my $api_instance = WWW::SwaggerClient::PostagensTMSApi->new();
my $body = WWW::SwaggerClient::Object::BodyCadastroPostagem->new(); # BodyCadastroPostagem | 

eval { 
    my $result = $api_instance->cadastrarPostagem(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PostagensTMSApi->cadastrarPostagem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.PostagensTMSApi()
body =  # BodyCadastroPostagem | 

try: 
    # Cadastro de postagem
    api_response = api_instance.cadastrar_postagem(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PostagensTMSApi->cadastrarPostagem: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Postagem criada com sucesso! Ja disponivel para operação no phoenix

Status: 400 - Mensagem de erro, alguma validação por parte da regra de negocio. alguns exemplos sao, Numero de encomenda já utilizado em sistema, Mensagem inválida - Normalmente quando se tem algum erro no body da requisicao.

Status: 500 - Algum erro nao previsto, caso aconteça entre em contato com o desenvolvedor do sistema

listarPostagensTracking

Rastreamento de postagem

Retorna as postagens encontradas de acordo com o codigo de rastreamento informado, sendo possivel buscar pelos 3 codigos de rastreio, MO, numero no cliente e numero no terceiro


/postagem/search

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://phoenixapi.moovelogistica.pt/phoenixapi/postagem/search?tracking="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PostagensTMSApi;

import java.io.File;
import java.util.*;

public class PostagensTMSApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PostagensTMSApi apiInstance = new PostagensTMSApi();
        String tracking = tracking_example; // String | 
        try {
            RetornoPaginadoPostagens result = apiInstance.listarPostagensTracking(tracking);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PostagensTMSApi#listarPostagensTracking");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PostagensTMSApi;

public class PostagensTMSApiExample {

    public static void main(String[] args) {
        PostagensTMSApi apiInstance = new PostagensTMSApi();
        String tracking = tracking_example; // String | 
        try {
            RetornoPaginadoPostagens result = apiInstance.listarPostagensTracking(tracking);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PostagensTMSApi#listarPostagensTracking");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *tracking = tracking_example; // 

PostagensTMSApi *apiInstance = [[PostagensTMSApi alloc] init];

// Rastreamento de postagem
[apiInstance listarPostagensTrackingWith:tracking
              completionHandler: ^(RetornoPaginadoPostagens output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PhoenixTmsApi = require('phoenix__tms___api');
var defaultClient = PhoenixTmsApi.ApiClient.instance;


var api = new PhoenixTmsApi.PostagensTMSApi()
var tracking = tracking_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listarPostagensTracking(tracking, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listarPostagensTrackingExample
    {
        public void main()
        {


            var apiInstance = new PostagensTMSApi();
            var tracking = tracking_example;  // String | 

            try
            {
                // Rastreamento de postagem
                RetornoPaginadoPostagens result = apiInstance.listarPostagensTracking(tracking);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PostagensTMSApi.listarPostagensTracking: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiPostagensTMSApi();
$tracking = tracking_example; // String | 

try {
    $result = $api_instance->listarPostagensTracking($tracking);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostagensTMSApi->listarPostagensTracking: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PostagensTMSApi;


my $api_instance = WWW::SwaggerClient::PostagensTMSApi->new();
my $tracking = tracking_example; # String | 

eval { 
    my $result = $api_instance->listarPostagensTracking(tracking => $tracking);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PostagensTMSApi->listarPostagensTracking: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.PostagensTMSApi()
tracking = tracking_example # String | 

try: 
    # Rastreamento de postagem
    api_response = api_instance.listar_postagens_tracking(tracking)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PostagensTMSApi->listarPostagensTracking: %s\n" % e)

Parameters

Query parameters
Name Description
tracking*
String
Required

Responses

Status: 200 - Retorna uma lista das postagens encontradas

Status: 500 - Erro interno no servidor.