One Way Manual do Sistemaapi.higs.com.br/Content/doc/One Way - V_1_5.pdf · Content-Type:...

One Way – Manual do Sistema 1

One Way Manual do Sistema

V1.5


Histórico de Revisões Data da Revisão Versão Descrição Autor 25/10/2016 V1.0 Formatação do documento Luciano Santos

27/10/2016 V1.1 Conteúdo (Insert, Visão geral e Carga) Patrick Melo

31/10/2016 V1.2 Conteúdo (Modify, parâmetros) Luciano Santos

07/11/2016 V1.3 Conteúdo (Mensagens de Erro) Luciano Santos

09/11/2016 V1.4 URL de request em Insert e Modify e Correção mensagem de Exception.

Patrick Melo

28/11/2016 V1.5 Conteúdo (campo Commission) Luciano Santos


Índice

Visão Geral ................................................................................................................................................................. 4

Autenticação .............................................................................................................................................................. 4

Idioma ........................................................................................................................................................................ 4

Descrição dos métodos .............................................................................................................................................. 5

Booking Insert ........................................................................................................................................................ 5

Request URL ....................................................................................................................................................... 5

Exemplo de Requisição ....................................................................................................................................... 5

Retorno sucesso ................................................................................................................................................. 5

Exemplo de Erro ................................................................................................................................................. 5

Erros do Método ................................................................................................................................................ 5

Parâmetros ......................................................................................................................................................... 8

Booking Modify .................................................................................................................................................... 13

Request URL ..................................................................................................................................................... 13

Exemplo de Requisição ..................................................................................................................................... 13

Retorno sucesso ............................................................................................................................................... 14

Exemplo de Erro ............................................................................................................................................... 14

Erros do Método .............................................................................................................................................. 14

Parâmetros ....................................................................................................................................................... 16

Booking Cancel ..................................................................................................................................................... 21

Request URL ..................................................................................................................................................... 21

Curl ................................................................................................................................................................... 21

Exemplo de Resposta ....................................................................................................................................... 21

Exemplo de Erro ............................................................................................................................................... 21

Erros do Método .............................................................................................................................................. 22

Parâmetros ....................................................................................................................................................... 22

Booking Search ..................................................................................................................................................... 23

Busca por código de reserva no HIGS ............................................................................................................... 23

Request URL ................................................................................................................................................ 23

Curl .............................................................................................................................................................. 23

Busca por código de reserva do parceiro ......................................................................................................... 23

Request URL ................................................................................................................................................ 23

Curl .............................................................................................................................................................. 23

Exemplo de Resposta ....................................................................................................................................... 23

Exemplo de Erro ............................................................................................................................................... 24

Erros do Método .............................................................................................................................................. 24

Parâmetros ....................................................................................................................................................... 24


Visão Geral

Este documento visa esclarecer todos os procedimentos de como consumir via JSON os recursos da HIGS API através de métodos HTTP.

Para ter acesso a HIGS API, é necessário possuir um Token Client e Token Application desbloqueados, que são recebidos após a contratação do nosso serviço. Todos os métodos HTTP que disponibilizam os recursos necessários para a integração são detalhados a seguir.

Autenticação Para ter acesso a HIGS API, é necessário possuir um Token Client e Token Application desbloqueados, que são recebidos após a contratação do nosso serviço. Os dois parâmetros devem ser inseridos no Header com os seus respectivos valores. Em todas as requisições a utilização dos tokens é obrigatória.

Exemplo:

Headers token-client: 54f11ad4ae0d17744fa33d99

token-application: 19A322AF-BF7C-4652-87A9-DF5BA91963F7

Content-Type: application/json;

Idioma O idioma de retorno das mensagens do sistema pode ser escolhido através do parâmetro Accept-Language que deve ser inserido no header. Idiomas disponíveis: en-US e pt-BR.

Obs: Com a ausência do parâmetro Accept-Language, o idioma retornado será pt-BR. Exemplo:

Headers token-client: 54f11ad4ae0d17744fa33d99

token-application: 19A322AF-BF7C-4652-87A9-DF5BA91963F7

Content-Type: application/json;

charset=utf-8

Accept-Language: en-US


Descrição dos Métodos

BookingInsert Método POST para inserir uma nova reserva, onde é gerado um identificador único. Todas as informações enviadas são validadas contra o estado atual dos dados. A inclusão da reserva pode ser recusada caso tenha ocorrido uma alteração de disponibilidade. Request URL

http://api.twoway.higs.com.br/api/v1/BookingInsert

Exemplo de requisição: Body

{

"CreatorId": "Test",

"SourceOfBusiness": "BOOKING",

"IdHotel": 2125,

"Checkin": "2016-12-07",

"Checkout": "2016-12-14",

"DateTimeInclusion": "2016-09-16T01:57:00",

"GuestCount": 2,

"NumberChildren": 0,

"MainGuest": {

"GivenName": "Bruno João",

"Surename": "Carvalho",

"Telephone": "2121212121",

"Address": {

"AdressLine": "Rua abc, 10 - Centro",

"CityName": "Rio de Janeiro",

"StateProv": "RJ",

"ZipCode": "21212121",

"CountryName": "BR",

"CompanyName": "CompanyCo"

},

"Email": "[email protected]"

},

"Guests": [

{

"GivenName": "Alfredo Iried",

"LastName": "Santos"

}

],

"Comment": "1 double and 2 single beds5 - Bill only nghts bkd to cc# @ ck-in gs",

"TypePayment": 1,

"TypeInvoice": null,

"CreditCardData": {

"Flag": "MC",

"Name": "VirtualCard",

"CardNumber": "000004544465800",

"SecurityCode": "001",

"Expiration": "09/20"

},

"RatePlanCode": "333",

"Commission": 25,

"RoomTypeCode": "noteste",

"HotelReservationIds": [

{

"HotelReservationNumber": "000907106/1",

"TypeReservation": 1

}

],

"Taxes": [{

"CodeTax": 1,

"Value": 1.0,

"Description": "ISS"


}],

"Rates": [

{

"EffectiveDate": "2016-12-07",

"Amount": 205.77

},

{

"EffectiveDate": "2016-12-08",

"Amount": 205.77

}

],

"TotalAmountBeforeTax": 1440.39,

"CurrencyCode": "BRL"

}

Retorno Sucesso Código HTTP: 200

Response {"HotelReservationIds":[

{"HotelReservationNumber":"00445/92",

"TypeReservation":1}

],

"Warning":null,

"Status":

{"Code":200,

"Message":"Ok."

}

}

Exemplo de Erro Código HTTP: 400

Response

{

"HotelReservationIds":null,

"Warning":[{"Code":1032,"Message":"O campo \"Email\" é inválido"}],

"Status":{"Code":400,"Message":"BadRequest"}

}

Erros do Método Código Interno Mensagem de Erro

1092 Agência / Empresa inválida

392 Código do hotel inválido

381 Data do check-in inválida

69 Critérios de estadia mínima no cumpridos

70 Critérios de estada máxima não cumpridos

397 Número inválido de adultos

893 Código de Imposto inválido

1087 Data do cartão de crédito inválida

1088 Bandeira inválida para este hotel

1090 Id de reserva do hotel inválido

111 Reserva inválida

1018 Origem inválida

1085 RoomType inválido

1100 Tarifa inválida

1026 O campo "CreatorId" é obrigatório.

1064 O campo "SourceOfBusiness" é obrigatório


1043 O campo "IdHotel" é inválido

1044 O campo "IdHotel" é obrigatório

1029 O campo "Checkin" é obrigatório

1030 O campo "Checkout" é obrigatório

1031 O campo "DateTimeInclusion" é obrigatório

1056 O campo "GuestCount" é inválido

1040 O campo "GuestCount" é obrigatório

1048 O campo "MainGuest" é obrigatório

1038 O campo "GivenName" é inválido

1039 O campo "GivenName" é obrigatório

1096 O tamanho do campo "GivenName" foi excedido

1066 O campo "SurName" é inválido

1067 O campo "SurName" é obrigatório

1097 O tamanho do campo "SurName" foi excedido

1069 O campo "Telephone" é obrigatório

1068 Limite para o campo "Telephone" excedido

1016 O campo "AdressLine" é obrigatório

1021 O campo "CityName" é obrigatório

1065 O campo "StateProv" é obrigatório

1055 O campo "ZipCode" é obrigatório

1025 O campo "CountryName" é obrigatório

1032 O campo "Email" é inválido

1033 O campo "Email" é obrigatório

1094 O tamanho do campo" Comment" foi excedido

1070 O campo "TypePayment" é inválido

1071 O campo " TypePayment" é obrigatório

1079 O campo "TypeInvoice" é inválido

1019 O campo "Flag" é inválido

1020 O campo "Flag" é obrigatório

1049 O campo "Name" é inválido

1050 O campo "Name" é obrigatório

1053 O campo "CardNumber" é obrigatório

1022 O campo "SecurityCode" é inválido

1023 O campo "SecurityCode" é obrigatório

1078 O campo "Expiration" é obrigatório

1058 O campo "RatePlanCode" é obrigatório

1060 O campo "RoomTypeCode" é obrigatório

1041 O campo "HotelReservationId" é inválido

1042 O campo "HotelReservationId" é obrigatorio

1075 O campo "TypeReservation" é inválido

1076 O campo "TypeReservation" é obrigatório

1101 O campo "Rates" é obrigatório

1098 O campo "EffectiveDate" é obrigatório

1099 O campo "Amount" é obrigatório

1072 O campo "TotalAmountBeforeTax" é obrigatório

1027 O campo "CurrencyCode" é inválido

1028 O campo "CurrencyCode" é obrigatório

156 Comissão não aplicável

157 Comissão zero não aceitável

1113 Campo Commission inválido

1114 Comissão não informada

9999 Campo <campo> Inválido


Parâmetros Parâmetro Descrição Tipo Obrigatório

CreatorId Nome do Sistema do parceiro. Exemplo: "CreatorId": "CRS HIGS"

String

SourceOfBusiness Código de origem da reserva. Este campo é usado para relacionar os Roomtypes e os RatePlans. A lista de origens está disponível no link http://api.higs.com.br/ Exemplo: "SourceOfBusiness": "BOOKING"

String(07)

IdHotel Código de identificação do Hotel no Higs. Exemplo: "IdHotel": 012345

Integer

Checkin Data de chegada do Hóspede. Exemplo: "Checkin": "2016-10-29"

String(10) (yyyy-MM-dd)

Checkout Data de saída do Hóspede. Exemplo: "Checkin": "2016-10-30"


DateTimeInclusion Data e hora da inclusão da Reserva no integrador. Exemplo: "DateTimeInclusion": "2016-10-03T17:59:50"

String(19) (yyyy-MM-ddThh:mm:ss)

GuestCount Quantidade total de hóspedes adultos. Exemplo: "GuestCount": 2

Integer

NumberChildren Quantidade total de hóspedes crianças. Exemplo: "NumberChildren": 1

Integer

MainGuest

Conjunto de informações de nome e endereço do hóspede.

GivenName Nome do hóspede. Exemplo: "GivenName": "Manoel"

String(30)

Surename Sobrenome do hóspede. Exemplo: "Surename": "da Silva"

String(30)

Telephone Telefone do hóspede. Exemplo: "Telephone": "(21) 9999 9999"

String(20)

http://api.higs.com.br/


Address

Conjunto de informações do endereço do hóspede

AdressLine Endereço do hóspede. Exemplo: "AdressLine": "Av. Principal, n° 500"

String(70)

CityName Cidade do hóspede. Exemplo: "CityName": "Campinas"

String(255)

StateProv Estado de residência do hóspede. Exemplo: "StateProv": "São Paulo"

String(255)

ZipCode Cep de residência do hóspede. Exemplo: "ZipCode": "20500-001"

String(12)

CountryName País de residência do hóspede. Exemplo: "CountryName": "Brasil"

String(255)

Email E-mail do hóspede ou do responsável pela reserva. Exemplo: "Email": "[email protected]"

String(50)

Guests

Conjunto de informações dos hóspedes acompanhantes. * Máximo de 03 hóspedes.

GivenName Primeiro Nome do hóspede acompanhante. Exemplo: "GivenName": "Estela Valdez"

String(30)

LastName Sobrenome do hóspede acompanhante. Exemplo: "LastName": "Garcia"

String(30)

Comment Notas e observações sobre a reserva. Exemplo: "Comment": "Booking Modify text"

String[1400]

TypePayment Identificação do tipo de pagamento: 1 – Cartão de Crédito 2 – Direto no Hotel 3 – Faturado para empresa Exemplo: "TypePayment": 2

Integer

TypeInvoice Lista de tipos de pagamento faturados para empresa. Usados somente quando o campo TypePayment = 3 (Invoice) Opções: Ty = Todas as despesas sem bebidas alcoólicas Tt = Todas as despesas Tx = Taxas An = Alimentação e bebidas não alcoólicas

Array[string]


Di = Diárias Cf = Café da manhã Tl = Telefonemas Tu = Taxas de turismo Bu = Frigobar Fb = Frigobar Lv = Lavanderia *Mínimo de 01 e máximo de 05 tipos são aceitos. Exemplo: "TypeInvoice": ["Ty","Tx","An","Tl","Tu"]

CreditCardData

Conjunto de informações de Cartão de Crédito. Preenchido somente quando o campo TypePayment = 1 (Cartão de Crédito). Nos demais casos os campos relativos ao conjunto de informações do cartão de crédito não precisam ser informados.

Flag Bandeira do cartão de crédito. Lista de bandeiras: GC - Good Card VI - Visa IK - Mastercard DC - Diners Club AX - American Express EL - ELO DS - Discover EV - Expedia Virtual Card Exemplo: "Flag": "VI"

String(02)

Name Nome impresso no cartão de crédito. Exemplo: "Name": "MANOEL SILVA"

String(30)

CardNumber Número do cartão de crédito. Exemplo: "CardNumber": "4444333322221111"

String(24)

SecurityCode Código de segurança do cartão de crédito. Exemplo: "SecurityCode": "123"

String(08)

Expiration Data de expiração do cartão de crédito no formato (mm/yy). Exemplo: "Expiration": "10/22"

String(05) (MM/yy)

RatePlanCode Código identificador do Rate Plan. Exemplo: "RatePlanCode": 20160101

String(64)


Commission

Valor da comissão para o contrato associado ao parceiro. Se o contrato associado ao RateplanCode obedecer alguma regra de comissionamento o campo passa a obedecer às seguintes regras: - Para contratos Comissionados: (obrigatório) "Commission": 25 - Para contratos Não Comissionados: (obrigatório) "Commission": 0 - Para contratos Indiferentes: *Não é necessário incluir o campo no bilhete

Integer

RoomTypeCode Código identificador do Roomtype do integrador. É necessário que o hotel realize previamente o correlacionamento de Roomtypes no HIGS. Exemplo: "RoomTypeCode": 201602

String(64)

HotelReservationIds

Lista de hotéis onde a reserva está sendo efetuada.

HotelReservationNumber Número de identificação da reserva no integrador. Exemplo: "HotelReservationNumber": "131362840"

String(30)

TypeReservation Código identificador do tipo da reserva no integrador. Exemplo: "TypeReservation": 1

Integer

Taxes

Lista de informações das taxas.

CodeTax Código identificador da taxa no HIGS. Lista de códigos de taxas: 1 - Taxa de serviço 2 - Imposto sobre serviços 3 - Taxa de turismo 4 - Taxa Ecológica 5 - Imposto Circulação de 6 - Imposto Agregado 18 - Food & beverage 28 - Taxa Juiz de Fora Exemplo: "CodeTax": 2

Integer

Value Valor da diária. Exemplo: "Value": 20.50

Number(12,2)


Description Descrição das taxas e impostos. Exemplo: "Description": "ISS"

String(50)

Rates

Lista de informação dos valores dia-a-dia da reserva.

EffectiveDate Data de realização da cobrança. (yyyy-mm-dd) Exemplo: "EffectiveDate": "2016-10-29


Amount Valor da diária. Exemplo: "Amount": 190.20

Number(16,2)

TotalAmountBeforeTax Valor total da reserva sem taxas e impostos. Exemplo: "TotalAmountBeforeTax": 190.20

Number(16,2)

CurrencyCode Código da moeda utilizada na reserva. Código padrão ISO 4207. Exemplo: "CurrencyCode": "BRL"

String(03)


BookingModify Método POST responsável por modificar uma reserva. O corpo da requisição para o método BookingModify se assemelha ao corpo do método BookingInsert, no entanto, o campo HotelReservationNumber receberá agora o código HIGS da reserva e o campo TypeReservation deverá ser do tipo 2. Request URL

http://api.twoway.higs.com.br/api/v1/BookingModify

Exemplo de requisição: Body

{

"CreatorId": "Teste",


"IdHotel": 2125,

"Checkin": "2016-12-07",

"Checkout": "2016-12-14",


"GuestCount": 2,


"MainGuest": {



"Telephone": "2121212121",

"Address": {



"StateProv": "RJ",

"ZipCode": "21212121",


"CompanyName": "Test"

},


},

"Guests": [

{

"GivenName": "Alfredo Inwied",


}

],


"TypePayment": 1,


"CreditCardData": {

"Flag": "MC",


"CardNumber": "000004544465800",



},


"Commission": 25,



{

"HotelReservationNumber": "99445492",


}

],

"Taxes": [{

"CodeTax": 1,

"Value": 1.0,


}],

"Rates": [

{

"EffectiveDate": "2016-12-07T00:00:00",

"Amount": 205.77

},


{

"EffectiveDate": "2016-12-08T00:00:00",

"Amount": 205.77

}

],



}

Retorno Sucesso Código HTTP: 200

Response {"HotelReservationIds":[

{"HotelReservationNumber":"99445492",

"TypeReservation":2}

],

"Warning":null,

"Status":

{"Code":200,

"Message":"Ok."

}

}


Response {

"HotelReservationIds":null,

"Warning":[{"Code":1032,"Message":"O campo \"Email\" é inválido"}],

"Status":{"Code":400,"Message":"BadRequest"}

}


1026 O campo "CreatorId" é obrigatório.

1064 O campo "SourceOfBusiness" é obrigatório

1043 O campo "IdHotel" é inválido

1044 O campo "IdHotel" é obrigatório

1029 O campo "Checkin" é obrigatório

1030 O campo "Checkout" é obrigatório

1031 O campo "DateTimeInclusion" é obrigatório

1056 O campo "GuestCount" é inválido

1040 O campo "GuestCount" é obrigatório

1048 O campo "MainGuest" é obrigatório

1038 O campo "GivenName" é inválido

1039 O campo "GivenName" é obrigatório

1096 O tamanho do campo "GivenName" foi excedido

1066 O campo "SurName" é inválido

1067 O campo "SurName" é obrigatório

1097 O tamanho do campo "SurName" foi excedido

1069 O campo "Telephone" é obrigatório

1068 Limite para o campo "Telephone" excedido

1016 O campo "AdressLine" é obrigatório

1021 O campo "CityName" é obrigatório


1065 O campo "StateProv" é obrigatório

1055 O campo "ZipCode" é obrigatório

1025 O campo "CountryName" é obrigatório

1032 O campo "Email" é inválido

1033 O campo "Email" é obrigatório

1094 O tamanho do campo" Comment" foi excedido

1070 O campo "TypePayment" é inválido

1071 O campo " TypePayment" é obrigatório

1079 O campo "TypeInvoice" é inválido

1019 O campo "Flag" é inválido

1020 O campo "Flag" é obrigatório

1049 O campo "Name" é inválido

1050 O campo "Name" é obrigatório

1053 O campo "CardNumber" é obrigatório

1022 O campo "SecurityCode" é inválido

1023 O campo "SecurityCode" é obrigatório

1078 O campo "Expiration" é obrigatório

1058 O campo "RatePlanCode" é obrigatório

1060 O campo "RoomTypeCode" é obrigatório

1041 O campo "HotelReservationId" é inválido

1042 O campo "HotelReservationId" é obrigatorio

1075 O campo "TypeReservation" é inválido

1076 O campo "TypeReservation" é obrigatório

1101 O campo "Rates" é obrigatório

1098 O campo "EffectiveDate" é obrigatório

1099 O campo "Amount" é obrigatório

1072 O campo "TotalAmountBeforeTax" é obrigatório

1027 O campo "CurrencyCode" é inválido

1028 O campo "CurrencyCode" é obrigatório

111 Reserva inválida

121 Reserva não encontrada

122 Reserva vencida. Não é possível alterar

1102 Reserva cancelada. Não é possível alterar

1092 Agência / Empresa inválida

392 Código do hotel inválido

381 Data do check-in inválida

69 Critérios de estadia mínima no cumpridos

70 Critérios de estada máxima não cumpridos

397 Número inválido de adultos

893 Código de Imposto inválido

1087 Data do cartão de crédito inválida

1088 Bandeira inválida para este hotel

1090 Id de reserva do hotel inválido

1018 Origem inválida

1085 RoomType inválido

1100 Tarifa inválida

156 Comissão não aplicável

157 Comissão zero não aceitável

1113 Campo Commission inválido

1114 Comissão não informada

9999 Campo <campo> Inválido



CreatorId Nome do Sistema do parceiro. Exemplo: "CreatorId": "CRS HIGS"

String(30)

SourceOfBusiness Código de origem da reserva. Este campo é usado para relacionar os Roomtypes e os RatePlans. A lista de origens está disponível no link http://api.higs.com.br/ Exemplo: "SourceOfBusiness": "BOOKING"

String(07)

IdHotel Código de identificação do Hotel no Higs. Exemplo: "IdHotel": 012345

Integer

Checkin Data de chegada do Hóspede. Exemplo: "Checkin": "2016-10-29"


Checkout Data de saída do Hóspede. Exemplo: "Checkin": "2016-10-30"


DateTimeInclusion Data e hora da inclusão da Reserva no integrador. Exemplo: "DateTimeInclusion": "2016-10-03T17:59:50"

String(19) (yyyy-MM-ddThh:mm:ss)

GuestCount Quantidade total de hóspedes adultos. Exemplo: "GuestCount": 2

Integer

NumberChildren Quantidade total de hóspedes crianças. Exemplo: "NumberChildren": 1

Integer

MainGuest

Conjunto de informações de nome e endereço do hóspede.

GivenName Nome do hóspede. Exemplo: "GivenName": "Manoel"

String(30)

Surename Sobrenome do hóspede. Exemplo: "Surename": "da Silva"

String(30)

Telephone Telefone do hóspede. Exemplo: "Telephone": "(21) 9999 9999"

String(20)

http://api.higs.com.br/


Address

Conjunto de informações do endereço do hóspede

AdressLine Endereço do hóspede. Exemplo: "AdressLine": "Av. Principal, n° 500"

String(70)

CityName Cidade do hóspede. Exemplo: "CityName": "Campinas"

String(255)

StateProv Estado de residência do hóspede. Exemplo: "StateProv": "São Paulo"

String(255)

ZipCode Cep de residência do hóspede. Exemplo: "ZipCode": "20500-001"

String(12)

CountryName País de residência do hóspede. Exemplo: "CountryName": "Brasil"

String(255)

Email E-mail do hóspede ou do responsável pela reserva. Exemplo: "Email": "[email protected]"

String(50)

Guests

Conjunto de informações dos hóspedes acompanhantes. * Máximo de 03 hóspedes.

GivenName Primeiro Nome do hóspede acompanhante. Exemplo: "GivenName": "Estela Valdez"

String(30)

LastName Sobrenome do hóspede acompanhante. Exemplo: "LastName": "Garcia"

String(30)

Comment Notas e observações sobre a reserva. Exemplo: "Comment": "Booking Modify text"

String[1400]

TypePayment Identificação do tipo de pagamento: 1 – Cartão de Crédito 2 – Direto no Hotel 3 – Faturado para empresa Exemplo: "TypePayment": 2

Integer

TypeInvoice Lista de tipos de pagamento faturados para empresa. Usados somente quando o campo TypePayment = 3 (Invoice) Opções: Ty = Todas as despesas sem bebidas alcoólicas Tt = Todas as despesas Tx = Taxas An = Alimentação e bebidas não alcoólicas Di = Diárias

Array[string]


Cf = Café da manhã Tl = Telefonemas Tu = Taxas de turismo Bu = Frigobar Fb = Frigobar Lv = Lavanderia *Mínimo de 01 e máximo de 05 tipos são aceitos. Exemplo: "TypeInvoice": ["Ty","Tx","An","Tl","Tu"]

CreditCardData

Conjunto de informações de Cartão de Crédito. Preenchido somente quando o campo TypePayment = 1 (Cartão de Crédito). Nos demais casos os campos relativos ao conjunto de informações do cartão de crédito não precisam ser informados.

Flag Bandeira do cartão de crédito. Lista de bandeiras: GC - Good Card VI - Visa IK - Mastercard DC - Diners Club AX - American Express EL - ELO DS - Discover EV - Expedia Virtual Card Exemplo: "Flag": "VI"

String(02)

Name Nome impresso no cartão de crédito. Exemplo: "Name": "MANOEL SILVA"

String(30)

CardNumber Número do cartão de crédito. Exemplo: "CardNumber": "4444333322221111"

String(24)

SecurityCode Código de segurança do cartão de crédito. Exemplo: "SecurityCode": "123"

String(08)

Expiration Data de expiração do cartão de crédito no formato (mm/yy). Exemplo: "Expiration": "10/22"

String(05) (MM/yy)

RatePlanCode Código identificador do Rate Plan. Exemplo: "RatePlanCode": 20160101

String(64)


Commission

Valor da comissão para o contrato associado ao parceiro. Se o contrato associado ao RateplanCode obedecer alguma regra de comissionamento o campo passa a obedecer às seguintes regras: - Para contratos Comissionados: (obrigatório) "Commission": 25 - Para contratos Não Comissionados: (obrigatório) "Commission": 0 - Para contratos Indiferentes: *Não é necessário incluir o campo no bilhete

Integer

RoomTypeCode Código identificador do Roomtype do integrador. É necessário que o hotel realize previamente o correlacionamento de Roomtypes no HIGS. Exemplo: "RoomTypeCode": 201602

String(64)

HotelReservationIds

Lista de hotéis onde a reserva está sendo efetuada.

HotelReservationNumber Número de identificação da reserva no HIGS. Exemplo: "HotelReservationNumber": "131362840"

String(30)

TypeReservation Código identificador do tipo da reserva no HIGS. Exemplo: "TypeReservation": 2

Integer

Taxes

Lista de informações das taxas.

CodeTax Código identificador da taxa no HIGS. Lista de códigos de taxas: 1 - Taxa de serviço 2 - Imposto sobre serviços 3 - Taxa de turismo 4 - Taxa Ecológica 5 - Imposto Circulação de 6 - Imposto Agregado 18 - Food & beverage 28 - Taxa Juiz de Fora Exemplo: "CodeTax": 2

Integer

Value Valor da diária. Exemplo: "Value": 20.50

Number(12,2)

Description Descrição das taxas e impostos. Exemplo: "Description": "ISS"

String(50)


Rates

Lista de informação dos valores dia-a-dia da reserva.

Rates

EffectiveDate Data de realização da cobrança. (yyyy-mm-dd) Exemplo: "EffectiveDate": "2016-10-29"


Amount Valor da diária. Exemplo: "Amount": 190.20

Number(16,2)

TotalAmountBeforeTax Valor total da reserva sem taxas e impostos. Exemplo: "TotalAmountBeforeTax": 190.20

Number(16,2)

CurrencyCode Código da moeda utilizada na reserva. Código padrão ISO 4207. Exemplo: "CurrencyCode": "BRL"

String(03)


BookingCancel Método GET responsável por cancelar uma reserva ativa. Será preciso passar na URL o parâmetro reservationNumberCmNet com o código da reserva HIGS conforme o exemplo a seguir:

Request URL

http://api.twoway.higs.com.br/api/v1/BookingCancel?reservationNumberCmNet=1234

Curl

curl -X GET --header "Accept: application/json" --header "token-client: werwer" --header "token-application: rwerw" "http://api.twoway.higs.com.br/api/v1/BookingCancel?reservationNumberCmNet=1234"

Exemplo de resposta

Response {


{



}

],

"Warning": null,

"Status": {

"Code": 200,

"Message": "Ok."

}

}


Response {

"HotelReservationIds": null,

"Warning": [

{

"Code": 122,

"Message": "Reserva vencida. Não é possível cancelar"

}

],

"Status": {

"Code": 200,

"Message": "Ok."

}

}



122 Reserva vencida. Não é possível cancelar

1080 Reserva não encontrada


reservationNumberCmNet Código da reserva do HIGS.

String

TypeReservation Código identificador do tipo da reserva no HIGS. Exemplo: "TypeReservation": 3

Integer


BookingSearch Método GET responsável por obter informações de uma reserva. A pesquisa pode ser feita pelo código de reserva do parceiro ou pelo código HIGS, através de dois métodos: - Busca por código de reserva HIGS

Request URL

http://api.twoway.higs.com.br/api/v1/BookingSearch/NumberHigs?reservationId=13455

Curl

curl -X GET --header "Accept: application/json" --header "token-client: 4545" --header "token-application: 65454" "http://api.twoway.higs.com.br/api/v1/BookingSearch/NumberHigs?reservationId=13455"

- Busca por código de reserva do parceiro

Request URL

http://api.twoway.higs.com.br/api/v1/BookingSearch/NumberPartner?reservationId=1234/44

Curl

curl -X GET --header "Accept: application/json" --header "token-client: hhfg" --header "token-application: hhgh" "http://api.twoway.higs.com.br/api/v1/BookingSearch/NumberPartner?reservationId=1234/44"

Exemplo de resposta

Response {

"CreatorId": "Teste",


"IdHotel": 2125,

"Checkin": "2016-12-07T00:00:00",

"Checkout": "2016-12-14T00:00:00",


"GuestCount": 2,


"MainGuest": {



"Telephone": "2121212121",

"Address": {



"StateProv": "RJ",

"ZipCode": "21212121",


"CompanyName": "CompanyCo"

},


},

"Guests": [

{

"GivenName": "Alfredo Inwinkelried",


}

],


"TypePayment": 1,



"CreditCardData": {

"Flag": "MC",


"CardNumber": "000004544465800",



},




{



}

],

"Taxes": [{

"CodeTax": 1,

"Value": 1.0,


}],

"Rates": [

{

"EffectiveDate": "2016-12-07T00:00:00",

"Amount": 205.77

},

{

"EffectiveDate": "2016-12-08T00:00:00",

"Amount": 205.77

}

],



}


Response {"ReservationSearch":null,

"Warning":[{"Code":284,"Message":"Reservas não localizadas nos critérios de busca"}],

"Status":{"Code":200,"Message":"OK"}

}


284 Reservas não localizadas nos critérios de busca


reservationId Código da reserva do parceiro ou do HIGS. String

One Way Manual do Sistemaapi.higs.com.br/Content/doc/One Way - V_1_5.pdf · Content-Type:...

Documents

Transcript of One Way Manual do Sistemaapi.higs.com.br/Content/doc/One Way - V_1_5.pdf · Content-Type:...