Anterior
Próximo
Imprimir

Manual de Integração via API

A sessão abaixo relaciona os tipos de requisições disponíveis para Ordem de Serviço.

 

Requisição de Autenticação

 

Para realizar as chamadas de inserção/Atualização Ordem de serviço, é necessário se autenticar na API. Passando as seguintes informações:

 

Autenticação

#

Campo

Descrição

1

Username

EnterpriseID

Identificador da empresa, cadastrado na aplicação nddConnect

2

Password

Token para autenticação da empresa, cadastrado na aplicação

3

Grant_type

Senha para autenticação da empresa, cadastrado na aplicação

4

Client_Id (Hashcode):

Valor padrão: 3b9a77fb35a54e40815f4fa8641234c5

Ao verificar a assinatura, o servidor de autorização pode confirmar que o aplicativo cliente que enviou a solicitação de token possui o segredo do cliente,

pelo qual o servidor de autorização pode autenticar o cliente.

 

 

As chamadas poderam ser simuladas via Postman, ferramenta que tem como objetivo testar serviços RESTful (Web APIs) por meio do envio de requisições HTTP e da análise do seu retorno.

 

URL de autenticação: https://localhost/Agent/Auth/token  

 

A imagem abaixo ilustra a chamada de autenticação, a qual irá retornar o token de acesso a API.

 

clip0001_zoom80

 

Após a obtenção o token de acesso este deverá ser informado nas chamadas de:

 

•Post: Inserção da Ordem de Serviço

•PUT: Atualização da Ordem de serviço

 

URL da  API de Ordem de Serviço: https://localhost/Document/api/ServiceOrder

 

clip0002_zoom80

 

Para funcionamento do Postman deveram ser informados os seguintes parâmetros:

 

•Type: Bearer Token

•Token: Token de acesso retornado na chamada de autenticação

 

Requisição de Inserção da Ordem de Serviço

 

{

  "nPed": "string",

  "statusPed": 0,

  "dPed": "2019-11-26T19:26:49.950Z",

  "vPed": 0,

  "cResp": "string",

  "allowanceValue": 0,

  "providerParticipant": {

    "name": "string",

    "identityNumber": 0,

    "ie": "string",

    "city": "string",

    "uf": "string"

  },

  "takerParticipant": {

    "name": "string",

    "identityNumber": 0,

    "ie": "string",

    "city": "string",

    "uf": "string"

  },

  "ownerId": "string"

}

 

Detalhamento da requisição da Ordem de Serviço

 

Inserir Incidente

#

Campo

Descrição

Tipo

Ob.

Tam.

Observação

1

NPed

Número do Pedido

N

S

1-15

 

2

StatusPed

Status do Pedido pode ser:

o0 = Aberto

o1 = Encerrado

o2 = Cancelado

N

S

-

 

3

DPed

Data do Pedido

D

S

-

 

Formato “DD-MM-AAAA”

4

VPed

Valor Total do Pedido(R$)

N

S

13

 

5

CResp

Pessoa Responsável(Comprador)

C

S

1-200

 

6

allowanceValue

 

N

S

-

 

7

Prestador

 

 

 

 

 

8

Name

Nome

C

S

1-200

 

9

identityNumber

CNPJ

N

S

14

 

10

IE

Inscrição Estadual

N

S

2-14

 

11

City

ICidade

C

S

1-200

 

12

UF

Estador

C

S

2

 

13

Tomador

 

 

 

 

 

14

Name

Nome

C

S

1-200

 

15

identityNumber

CNPJ

N

S

14

 

16

IE

Inscrição Estadual

N

S

2-14

 

17

City

Cidade

C

S

1-200

 

18

UF

Estado

C

S

2

 

19

ownerId

Identificação do cliente na aplicação

C

S

 

 

 

 

 

Ao enviar um participante cujo CNPJ já está configurado na aplicação nddConnect e os dados "IE","Cidade"e "UF", estam divergentes do cadastro, o participante será atualizado.

Ao enviar um participante cujo CNPJ não está configurado na aplicação nddConnect, o mesmo será cadastrado.

 

Requisição de Atualização da Ordem de Serviço

 

{

  "nPed": "string",

  "statusPed": 0,

  "dPed": "2019-11-26T19:43:15.079Z",

  "vPed": 0,

  "allowanceValue": 0,

  "providerParticipantId": 0,

  "providerParticipant": {

    "name": "string",

    "identityNumber": 0,

    "ie": "string",

    "city": "string",

    "uf": "string"

  },

  "takerParticipantId": 0,

  "takerParticipant": {

    "name": "string",

    "identityNumber": 0,

    "ie": "string",

    "city": "string",

    "uf": "string"

  },

  "ownerId": "string"

}

 

Detalhamento da requisição de atualização da Ordem de Serviço

 

Inserir Incidente

#

Campo

Descrição

Tipo

Ob.

Tam.

Observação

1

NPed

Número do Pedido

N

S

1-15

Valor não pode ser editado

2

StatusPed

Status do Pedido pode ser:

o0 = Aberto

o1 = Encerrado

o2 = Cancelado

N

S

-

 

3

DPed

Data do Pedido

D

S

-

 

Formato “DD-MM-AAAA”

4

VPed

Valor Total do Pedido(R$)

N

S

13

 

5

CResp

Pessoa Responsável(Comprador)

C

S

1-200

 

6

allowanceValue

 

N

S

-

 

7

Prestador

 

 

 

 

 

8

Name

Nome

C

S

1-200

 

9

identityNumber

CNPJ

N

S

14

 

10

IE

Inscrição Estadual

N

S

2-14

 

11

City

ICidade

C

S

1-200

 

12

UF

Estador

C

S

2

 

13

Tomador

 

 

 

 

 

14

Name

Nome

C

S

1-200

 

15

identityNumber

CNPJ

N

S

14

 

16

IE

Inscrição Estadual

N

S

2-14

 

17

City

Cidade

C

S

1-200

 

18

UF

Estado

C

S

2

 

19

ownerId

Identificação do cliente na aplicação

C

S

 

 

 

 

 

Ao enviar um participante cujo CNPJ já está configurado na aplicação nddConnect e os dados "IE","Cidade"e "UF", estam divergentes do cadastro, o participante será atualizado.

Ao enviar um participante cujo CNPJ não está configurado na aplicação nddConnect, o mesmo será cadastrado.

 

Exemplo de Retorno da Requisição

 

Código 200

Success, Chamada realizada com sucesso

 

Código 400

{

  "errorCode": 0,

  "errorMessage": "string",

  "errors": [

    {

      "propertyName": "string",

      "errorMessage": "string",

      "attemptedValue": {},

      "customState": {},

      "errorCode": "string",

      "formattedMessageArguments": [

        {}

      ],

      "formattedMessagePlaceholderValues": {

        "additionalProp1": {},

        "additionalProp2": {},

        "additionalProp3": {}

      },

      "resourceName": "string"

    }

  ]

}

 

 

O retorno obtido através da API informa se o envio da requisição foi processado com sucesso. Caso a mensagem enviada não possua as informações obrigatórias, será retornado falha.