Nota de atualização - 31/11/2020
5 min
Criado por: Ana Bittencourt em: 30/11/2020 09:33
OBSERVAÇÃO: esse artigo é destinado a usuários que utilizam nossa API, especificamente o endpoint  api.pipe.run/v1/deals para alguma integração.

Com o objetivo de otimizar o consumo de recursos computacionais, melhorar a performance e padronizar endpoints, estamos implantando mudanças na API do CRM PipeRun. Com isso, o endpoint de deals - responsável por retornar as Oportunidades - passará por alterações. Estamos ajustando o retorno e padronizamos a API conforme os demais endpoints.

 

ATENÇÃO: as alterações em nossa API entram em vigor a partir de 1º de fevereiro de 2021. Antes dessa data, disponibilizamos um ambiente específico para que nossos clientes possam atualizar e testar suas integrações. 

 

A seguir, confira as mudanças que serão implementadas no endpoint de /v1/deals.

 

Foram realizadas mudanças no endpoint de deals no intuito de ajustar o retorno e padronizá-lo conforme o restante dos endpoints. Nesse sentido, relações que antes eram feitas de maneira automática, não ocorrerão mais dessa forma. Implantamos essa alteração para otimizar o consumo de recursos computacionais.

1. Relações sofrerão alterações e não serão feitas de forma automática: 

    1. custom_fields 

 A Relação custom_fields passa a ser opcional. Para retornar deve ser especificado no parâmetro "with", conforme exemplo abaixo:

 GET api.pipe.run/v1/deals?with=custom_fields


2. Novas relações opcionais que passarão a estar disponíveis: 

    1. owner

    2. users

    3. pipeline

    4. stage

    5. person

    6. company

    7. tags

    8. proposal

    9. activityStats

    10. companies

    11. persons

    12. city

 

Para utilizar basta concatenar ao final da seguinte forma:  

GET api.pipe.run/v1/deals?with=custom_fields,users,stage,person(etc...)


3. O campo data_congelamento passa a vir como frozen_at;


4. Mudanças referente ao retorno da paginação: 

Legado

Atual

  "meta": {

        "total": 7782,

        "count": 1,

        "per_page": 1,

        "current_page": 1,

        "total_pages": 7782,

        "prev": null,

        "next": 2,

        "show": 1,

        "page": 1,

        "pages": 7782,

        "links": {

            "prev": null,

            "next": "http://beta-api.pipe.run/v1/deals?show=1&page=2"

        }

    }

"meta": {

        "total": 7808,

        "count": 1,

        "per_page": 1,

        "current_page": 1,

        "total_pages": 7808,

        "links": {

            "next": "http://local.piperunapi:81/v1/deals?show=1&page=2"

        }

    }

 


5. Comparativo de resposta do endpoint: api.pipe.run/v1/deals de JSON entre o retorno antigo e novo retorno: 

Legado

Atual

{

    "success": true,

    "message": "OK",

    "data": [

        {

            "id": Integer,

            "hash": "3f87tp9lav03lamu6eoqldr4jty4cyt",

            "rdstation_reference": null,

            "data_congelamento": null,

            "type_reference": null,

            "reference": null,

            "temperature": 4,

            "probability": "0.00",

            "account_id": 1,

            "pipeline_id": 1,

            "owner_id": 8,

            "stage_id": 21,

            "person_id": 215,

            "company_id": 124,

            "lost_reason_id": null,

            "origin_id": null,

            "started_in_stage_id": null,

            "city_id": null,

            "created_at": "2020-07-15 14:52:52",

            "title": "Inbound Báscio",

            "description": null,

            "observation": null,

            "status": 1,

            "closed_at": "2016-02-16 20:51:34",

            "reason_close": null,

            "deleted": 0,

            "freezed": 0,

            "value": "10420.00",

            "order": 67,

            "updated_at": "2020-07-15 14:52:52",

            "last_stage_updated_at": "2020-07-15 14:52:52",

            "value_mrr": "0.00",

            "probably_closed_at": "2017-05-25",

            "last_contact_at": "2017-05-25 15:23:38",

            "stage_changed_at": null,

            "custom_fields": [

                {

                    "id": 14853,

                    "hash": "9d7df470e0bf4067a03eca7abf6554e6",

                    "currency_id": null,

                    "decimal_places": null,

                    "thousand_sep": null,

                    "description": null,

                    "account_id": 335,

                    "name": "Equipamento",

                    "belongs": 1,

                    "type": 1,

                    "values": [],

                    "pivot": {

                        "id_orcamento": 180,

                        "id_campo_custom": 14853,

                        "valor": "10",

                        "created_at": "2020-07-15 14:52:52",

                        "updated_at": "2020-07-15 14:52:52"

                    }

                },

                {

                    "id": 21547,

                    "hash": "47e5e4c9ab1dba209e8106124971ff49",

                    "currency_id": null,

                    "decimal_places": 2,

                    "thousand_sep": 0,

                    "description": null,

                    "account_id": 1,

                    "name": "Formula 1",

                    "belongs": 1,

                    "type": 13,

                    "values": [],

                    "pivot": {

                        "id_orcamento": 180,

                        "id_campo_custom": 21547,

                        "valor": null,

                        "created_at": "2020-09-15 13:45:56",

                        "updated_at": "2020-09-15 13:45:56"

                    }

                }

            ]

        }

    ],

    "meta": {

        "total": 7782,

        "count": 1,

        "per_page": 1,

        "current_page": 1,

        "total_pages": 7782,

        "prev": null,

        "next": 2,

        "show": 1,

        "page": 1,

        "pages": 7782,

        "links": {

            "prev": null,

            "next": "http://beta-api.pipe.run/v1/deals?show=1&page=2"

        }

    }

}

{

    "success": true,

    "message": "OK",

    "data": [

        {

            "id": 1858671,

            "account_id": 1,

            "pipeline_id": 7061,

            "owner_id": 7297,

            "stage_id": 35404,

            "person_id": null,

            "company_id": null,

            "lost_reason_id": null,

            "origin_id": null,

            "started_in_stage_id": 35404,

            "city_id": null,

            "title": "deal do wil",

            "description": null,

            "observation": null,

            "value": null,

            "value_mrr": null,

            "order": 9,

            "created_at": "2020-06-29 11:26:01",

            "updated_at": "2020-06-29 11:26:01",

            "closed_at": null,

            "last_stage_updated_at": "2020-06-29 11:26:01",

            "probably_closed_at": null,

            "last_contact_at": null,

            "stage_changed_at": null,

            "frozen_at": null,

            "hash": "t2k8v1rzw004g400w0ggwsgskkgk4ws",

            "deleted": 0,

            "freezed": 0,

            "status": 0,

            "reason_close": null,

            "type_reference": null,

            "reference": null,

            "temperature": null,

            "probability": null,

            "lead_time": 94

        }

    ],

    "meta": {

        "total": 7808,

        "count": 1,

        "per_page": 1,

        "current_page": 1,

        "total_pages": 7808,

        "links": {

            "next": "http://local.piperunapi:81/v1/deals?show=1&page=2"

        }

    }

}

 

Em caso de dúvidas, entre em contato com nossa equipe de suporte

O que você achou deste artigo?
Últimos artigos visitados