Manual de Integração

Versão Atualizado Autor Páginas

1.4 03/06/2022 Prime Systems 2 / 15

Sumário
Sumário ................................................................................................................................ 2

Controle do Documento ........................................................................................................ 3

1. Apresentação ................................................................................................................. 4

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

3. Cadastro de tarefas no Primebuilder.............................................................................. 5

4. Consulta de tarefas ........................................................................................................ 7

5. Alteração de dados da OS (chamado) ........................................................................... 7

6. Consulta de tarefa pelo identificador no Primebuilder .................................................... 8

7. Cadastro de cliente ........................................................................................................ 9

8. Alterar de cliente ...........................................................................................................10

9. Excluir cliente ................................................................................................................11

10. Listar clientes .............................................................................................................11

10.1. Listar cliente individualmente .................................................................................12

10.2. Listar cliente com filtro pelo nome ..........................................................................13

 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 3 / 15

Controle do Documento

Descrição Data Autor

Criação do Documento 20/02/2018 Equipe Atendimento

Inserção de Exemplo JSON 20/07/2020 PMO
Inserção do método para alteração (item 6) 20/10/2020 PMO
Atualização – Cadastro de Cliente 03/06/2022 PMO
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 4 / 15

1. Apresentação

O processo de integração com PrimeBuilder é realizado por meio de um serviço baseado

em tecnologia Json, disponibilizado pela PrimeBuilder, de forma que clientes possam
consumi-lo.

O processo é realizado, basicamente da seguinte forma:

- Cliente autentica-se no Primebuider;

- Cliente envia dados a serem inseridos no Primebuilder;

2. Autenticação

Para autenticação deve ser chamado o processo de autenticação, conforme informações

abaixo:

URL: https://api.primebuilder.com.br/main/auth

Método: Post

Body:

Tipo: raw / text

Preencher campos em vermelho com os dados da instancia.

username=[nomedeusuario]&password=[senha]&workspace=[id]&grant_type=
password

A resposta a esta chamada é um token, que deve ser utilizado em todas as chamadas
subsequentes para operações com o PrimeBuilder (cadastro de clientes, cadastro de tarefas
/ campanhas; etc.).

O token gerado e recebido tem um formato conforme abaixo:

 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 5 / 15

3. Cadastro de tarefas no Primebuilder

Para enviar uma tarefa para o Primebuilder deve ser utilizado o seguinte método:

url: http://api.primebuilder.com.br/Main/v1/movement/tasks/

Método: Post

Headers:

São enviados 3 parâmetros no cabeçalho:

Autorization: Bearer (aqui deve ser informado o token recebido no processo de
autenticação)
ACCEPT: text/csv
Content-Type: application/json

As informações da OS (chamado) devem ser enviadas no corpo de chamado ao processo,

da seguinte forma:

Body:

Tipo: raw, application/Json

Modelo Json de OS:

"Limit": "2017-11-12T09:02:33", // Data Limite para execução do chamado

"Observation": "", // Observacao

"ScheduledDate": "2017-11-06T09:02:33”, //Data de Agendamento

 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 6 / 15

"User": 68592, // Id de Usuário

"Office": 1029, // Id da Filial

"Address": { // Campos de endereço da OS

"Street": "Rua da Bahia ",

"Number": " 2140 ",

"Complement": "",

"Neighborhood": "Lourdes",

"City": "Belo horizonte",

"StateAcronym": "MG",

"CountryAcronym": "BR",

"PostalCode": "",

"Latitude": 0,

"Longitude": 0

},

"Region":1, // Região

"Customer": 1525620, // Id do Cliente

"Workflow": 37518, //Id do Fluxo

"Group": 345565 //Id do Grupo de OS

O retorno a esta chamada é o ID (identificador interno no PrimeBuilder) do registro (tarefa /

campanha, etc.) criada no Primebuilder.
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 7 / 15

4. Consulta de tarefas

Este processo é utilizado para consultar uma tarefa / campanha, etc. cadastrada no
Primebuilder. Caso não seja informado um filtro na solicitação, o processo limitará a resposta
a um total de 10 de registros. A utilização deste processo deve ser feita da seguinte forma:

url: http://api.primebuilder.com.br/Main/v1/movement/tasks?status=Ativa

O status “Ativa” indica que serão listados somente as tarefas ativas (válidas) no
PrimeBuilder.

Método: GET

Authorization: Bearer (aqui deve ser informado o token recebido no processo de

autenticação).

Este processo retorna as informações das OS’s (chamados), em formato Json, conforme
imagem abaixo:

5. Alteração de dados da OS (chamado)

Para alterar o usuário de uma OS (Chamado). Para isso deve ser chamada a API, conforme
abaixo:

URL: http://api.primebuilder.com.br/v1/movement/tasks/{code}/edit

BODY
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 8 / 15

{
User:{
Id:{id}
Login:{login}
},
ScheduledDate: "2020-02-08T15:38:00-0300",
LimitDate: "2020-02-08T15:38:00-0300"
}

 As propriedades Id e Login são excludentes, ou seja, deve ser usado uma outra.
 API permite atualizar as propriedades User, ScheduledDate ou LimitDate. Portanto
não é necessário enviar todas ao mesmo tempo.

6. Consulta de tarefa pelo identificador no Primebuilder

Este processo retorna os dados de uma OS (chamado) específico. Este processo deve ser
utilizado da seguinte forma:

url: http://api.primebuilder.com.br/Main/v1/movement/tasks/ID_OS

Método: GET

Authorization: Bearer (aqui deve ser informado o token recebido no processo de

autenticação)

Este processo retorna as informações das OS’s (chamados), em formato Json, conforme
imagem abaixo:
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 9 / 15

7. Cadastro de cliente

Este processo cadastra um cliente no PrimeBuilder. Este processo deve ser utilizado da
seguinte forma:

url: https://api.primebuilder.com.br/main/v1/foundation/customers

Método: POST

Authorization: Bearer (aqui deve ser informado o token recebido no processo de

autenticação)

Este processo retorna o ID do cliente cadastrado no PrimeBuilder.

Exemplo (BODY)

"Code": "6326M_NA",
"Name": "XXXXXXXXXXXXXX YYYY ZZZZZZZZZZ",
"Cnpj": "6326M ",
"Email": [
"email@email.com.br"
],
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 10 / 15

"Phone": "9999999",
"ContactName": "Não informado",
"Address": {
"Street": "Rua Quintino Bocaiúva",
"Number": "541",
"Complement": "",
"Neighborhood": "Centro",
"City": "Governador Valadares",
"StateAcronym": "MG",
"CountryAcronym": "BR",
"PostalCode": "35010220",
"Latitude": 0.0,
"Longitude": 0.0
},
"Tags": [],
"TreatmentArea": {
"Id": 434,
"Code": "Nova area de atendimento",
"Name": "nova area de atendimento"
}
}

8. Alterar de cliente

Este processo altera os dados de um cliente cadastrado no PrimeBuilder. Este processo

deve ser utilizado da seguinte forma:

url: https://api.primebuilder.com.br/main/v1/foundation/customers

Método: PUT

Authorization: Bearer (aqui deve ser informado o token recebido no processo de

autenticação).

Este processo retorna o ID do cliente alterado.

Exemplo (BODY):

{
"Id": 2053797,
"Code": "6326MN",
"Name": "ZZZZZZZZZZZZZZZZ YYYYYYYYYYYYYYYYY XXXXXXXXXXXXXXXXXXX",
"Cnpj": "1234567890123z",
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 11 / 15

"Email": [
"email@email.com.br"
],
"Phone": "9999999",
"ContactName": "Não informado",
"Address": {
"Street": "Rua Quintino Bocaiúva",
"Number": "541",
"Complement": "",
"Neighborhood": "Centro",
"City": "Governador Valadares",
"StateAcronym": "MG",
"CountryAcronym": "BR",
"PostalCode": "35010220",
"Latitude": 0.0,
"Longitude": 0.0
},
"Tags": [],
"TreatmentArea": {
"Id": 434,
"Code": "Nova area de atendimento",
"Name": "nova area de atendimento"
}
}

9. Excluir cliente

Este processo exclui um cliente cadastrado no PrimeBuilder. Este processo deve ser
utilizado da seguinte forma:

url: https://api.primebuilder.com.br/main/v1/foundation/customers/[ID DO CLIENTE]

Método: DELETE

Authorization: Bearer (aqui deve ser informado o token recebido no processo de

autenticação).

Este processo retorna informação “true” quando sucesso.

10. Listar clientes

Este processo retorna, de forma resumida, os clientes cadastrados no PrimeBuilder. Este

processo deve ser utilizado da seguinte forma:
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 12 / 15

url: https://api.primebuilder.com.br/main/v1/foundation/customers/lookup

Método: GET

Authorization: Bearer (aqui deve ser informado o token recebido no processo de

autenticação).

Este processo retorna, de forma resumida, em formato JSON, os clientes cadastrados.

Exemplo:

{
"Id": 2050677,
"Code": "2605",
"Name": "DougPrime"
}

10.1. Listar cliente individualmente

Este processo exclui um cliente cadastrado no PrimeBuilder. Este processo deve ser
utilizado da seguinte forma:

url: https://api.primebuilder.com.br/main/v1/foundation/customers/[ID do cliente]

Método: GET

Authorization: Bearer (aqui deve ser informado o token recebido no processo de

autenticação).

Este processo retorna, em formato JSON, os dados do cliente [ID] passado na URL

Exemplo:

{
"Id": 2050677,
"Code": "2605",
"Name": "DougPrime",
"Cnpj": "26566619860 ",
"Email": [
"douglas.carvalho@primesystems.com.br"
],
"Phone": "11983759900",
"ContactName": "Douglas",
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 13 / 15

"Address": {
"Street": "Rua Osman Fonseca",
"Number": "113",
"Complement": "",
"Neighborhood": "Jd Luanda",
"City": "São Paulo",
"StateAcronym": "SP",
"CountryAcronym": "BR",
"PostalCode": "04678030",
"Latitude": 0.0,
"Longitude": 0.0
},
"CustomerGroup": {
"Id": 2395,
"Code": "Bradesco",
"Name": "Bradesco",
"Href": "v1/foundation/customergroup/2395"
},
"CustomerCategory": {
"Id": 324,
"Code": "categoria2",
"Name": "VIP"
},
"Tags": []
}

10.2. Listar cliente com filtro pelo nome

Este processo exclui um cliente cadastrado no PrimeBuilder. Este processo deve ser
utilizado da seguinte forma:

url: https://api.primebuilder.com.br/main/v1/foundation/customers?Name=XXXX YYYY

Método: GET

Authorization: Bearer (aqui deve ser informado o token recebido no processo de

autenticação).

Este processo retorna, em formato JSON, os dados dos clientes que atendam ao filtro
passado na URL

Exemplo:

[
{
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 14 / 15

"Id": 2050677,
"Code": "2605",
"Name": "DougPrime",
"Cnpj": "26566619860 ",
"Email": [
"douglas.carvalho@primesystems.com.br"
],
"Phone": "11983759900",
"ContactName": "Douglas",
"Address": {
"Street": "Rua Osman Fonseca",
"Number": "113",
"Complement": "",
"Neighborhood": "Jd Luanda",
"City": "São Paulo",
"StateAcronym": "SP",
"CountryAcronym": "BR",
"PostalCode": "04678030",
"Latitude": 0.0,
"Longitude": 0.0
},
"CustomerGroup": {
"Id": 2395,
"Code": "Bradesco",
"Name": "Bradesco",
"Href": "v1/foundation/customergroup/2395"
},
"CustomerCategory": {
"Id": 324,
"Code": "categoria2",
"Name": "VIP"
},
"Tags": []
}
]
 Manual de Integração
Versão Atualizado Autor Páginas
1.4 03/06/2022 Prime Systems 15 / 15

“Tecnologia para transformar os processos das empresas

de forma simples, ágil e flexível”.