NectarCRM API

Esse é um repositório para auxílio na API NectarCRM.

Colocaremos materiais e webhooks para que a integração seja facilitada.

Nota: Qualquer erro ou sugestão, por favor nos contate.

Esta API permite o controle total dos contatos, oportunidades, tarefas e compromissos. Veja as instruções de como realizar a integração abaixo. ###Clique aqui para a documentação completa

Instruções para realizar a integração

URL de acesso

https://app.nectarcrm.com.br/crm/api/1/ ######Obs: utilize o HTTPS, pois o HTTP ainda funciona vai ser desabilitado em breve

Requisição HTTP

Seguimos a estrutura padrão do estilo RESTful

GET: lista ou consulta dados
POST: criação de dados
PUT: atualização de dados
DELETE: remoção de dados

Dica: quando estiver listando, você pode escolher os campos que deseja trazer enviando o parâmetro "attribute" na URL.

Exemplo: /crm/api/1/oportunidades?attribute=id&attribute=nome Apenas id e nome virá na listagem.

Retorno

Response (application/json)

    {
        "sobre": {
            "versao": "1.0",
            "creditos": "Colmeia Soluções"
        },
        "endpoints": {
            "contatos": {
                "edicao": {
                    "response": 200,
                    "title": "Edicao de contatos",
                    "method": "PUT",
                    "endpoint": "http://app.nectarcrm.com.br/crm/api/1/contatos/:id"
                },
                "listagem": {
                    "response": 200,
                    "title": "Listagem de contatos",
                    "method": "GET",
                    "endpoint": "http://app.nectarcrm.com.br/crm/api/1/contatos"
                }
                //...outros métodos abaixo
            }
        }
    }

Como autenticar

É necessário passar o token privado de autenticação para conseguir realizar as operações. Para conseguir esse token, acesse no NectarCRM a seção Configurações -> Integrações.

Com esse token, você acessa, edita e excluir as informações possíveis pela API.

Você pode optar por 2 caminhos:

Enviar header na requisição Access-Token SEU_TOKEN

curl http://app.nectarcrm.com.br/crm/api/1/contatos/ -H "Access-Token: c5520d027fd1475b97a7a3aab50886f4"

Enviar parâmetro na URL de requisição api_token= SEU_TOKEN

curl http://app.nectarcrm.com.br/crm/api/1/contatos/?api_token=c5520d027fd1475b97a7a3aab50886f4

Códigos de respostas

200 (application/json)
```
  Sucesso
```
401 (text/json)
```
  Algum parâmetro enviado errado
```
403 (text/json)
```
  Acesso negado
```
404 (text/json)
```
  Registro não encontrado
```
500 (text/json)
```
  Erro do servidor
```

Padrões de listagens

Em todas listagem existem os padrões que seguimos para paginação e busca.

Parâmetros

&page

Número da página de listagem (integer)
&displayLength

Quantidade de objetos a serem listados por página (máximo 200)

Busca

&exato

Faz a busca exata pelo campo pedido. Se tiver colocado &nome=test, ele buscará por qualquer coisa começada com "test". Porém, com o parâmetro &exato=true, ele somente encontrará o item com nome igual a "test"

Padrão de endpoints

Para listagem, use GET: /endpoint/
Para inserção, use POST: /endpoint/
Para visualização, use GET: /endpoint/{id}
Para atualização, use PUT: /endpoint/{id}
Para exclusão, use DELETE: /endpoint/

Seções (endpoints) disponíveis

Segue as seções que você pode acessar pela API

Principais:

Tabelas administrativas

/campoPersonalizado
/produto
/produtoCategoria
/produtoSubCategoria
/tabelaPreco
/lista
/origem
/segmento
/categoria
/*/tipos (tipos de cadastros administrativos /secao/tipos)
/usuario
/webhook
/equipe
/proposta

Outros

Com o tempo vamos documentando todos endpoints, mas ainda existem alguns que podem não terem sidos documentados. Para não ficar sem informação, criamos um endpoint que lista todos objetos e campos possíveis da API:

https://app.nectarcrm.com.br/crm/api/1/app/columns/full

Header

A requisição deve conter:

Content-Type: application/json
Access-Token: SEU_TOKEN_AQUI

Para mais informações, consulte a documentação completa clicando aqui

##Integração RDStation Para informações de integração com RDStation, clique aqui

isaiastavares/nectarcrm-api