Atenção: esse é um artigo de caráter técnico.

Primeiramente, você vai precisar de duas coisas para realizar a integração via API:

Da ajuda de um programador
Do seu token de autenticação (que pode ser encontrado em Menu > Integrações)

Recomendamos que utilize a nossa biblioteca de exemplos de uso da API V3. Essa é a forma mais fácil e completa de entender e testar a nossa API.

(Tela do Postman testando a rota de criar ou atualizar pessoas)

Exemplos dos casos mais comuns de uso da API

Obs: Os exemplos abaixo estão com o comando curl, que é um comando já instalado na maioria dos computadores Linux e Mac OS. Se você estiver no Windows, você pode baixá-lo e instalar ou utilizar um simulador online para testar.

1. Como criar uma pessoa passando o e-mail e caso ela exista, apenas atualizá-la? (sem duplicar informações)


curl -X POST \
  https://api.agendor.com.br/v3/people/upsert \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json' \
  -d '{
	"name": "João",
	"contact": {
		"email": "joao@empresa.com.br"
	}
}'

2. Como criar uma empresa passando o CNPJ e caso ela exista, apenas atualizá-la? (sem duplicar informações)


curl -X POST \
  https://api.agendor.com.br/v3/organizations/upsert \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json' \
  -d '{
	"name": "Empresa",
	"cnpj": "joao@empresa.com.br"
}'

3. Como criar um negócio na primeira etapa do funil e agendar uma tarefa do tipo ligação?


# Criar o negócio
curl -X POST \
  https://api.agendor.com.br/v3/organizations/8249304/deals \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json' \
  -d '{
	"title": "Venda Delícias de Cacau #776",
	"value": "123",
	"dealStage": 1
}'

# Criar a tarefa
curl -X POST \
  https://api.agendor.com.br/v3/deals/4735940/tasks \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json' \
  -d '{
	"text": "Ligar",
	"due_date": "2018-06-05T12:00:00Z",
	"user": "70",
	"type": "LIGACAO"
}'

4. Como buscar uma pessoa pelo e-mail?


curl -X GET \
  'https://api.agendor.com.br/v3/people?email=joao@acme.com.br' \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json'

5. Como buscar as pessoas criadas ou atualizadas na última hora?


# Supondo que agora são 08:00 da manhã do dia 05 de Junho, vamos enviar o parâmetro since=2018-06-05T07:00:00Z
curl -X GET \
  'https://api.agendor.com.br/v3/people/stream?since=2018-06-05T07%3A00%3A00Z' \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json'

Por padrão, serão retornados os 3 itens mais recentes. Se houverem mais para serem buscados, a resposta irá conter o atributo links.next com a URL necessária para requisitar a próxima página.

6. Como buscar as empresas criadas ou atualizadas na última hora?


# Supondo que agora são 08:00 da manhã do dia 05 de Junho, vamos enviar o parâmetro since=2018-06-05T07:00:00Z
curl -X GET \
  'https://api.agendor.com.br/v3/organizations/stream?since=2018-06-05T07%3A00%3A00Z' \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json'
allowedUsers

Por padrão, serão retornados os 3 ítens mais recentes. Se houverem mais para serem buscados, a resposta irá conter o atributo links.next com a URL necessária para requisitar a próxima página.

7. Como alterar a privacidade de um negócio para que apenas um usuário tenha acesso?

# Supondo que o seu o usuário possui o id 1234
curl -X PUT \
  'https://api.agendor.com.br/v3/deals/1012' \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json' \
  -d '{
	"allowedUsers": [1234]
}'

O atributo allowedUsers recebe um array . Você pode passar mais de um ID de usuário separando por vírgula. Ex: "allowedUsers": [1234, 345, 23859] .
Esse mesmo parâmetro pode ser usado para as rotas /people e /organizations .

8. Como alterar a privacidade de uma empresa que está fechada para que todos os usuários tenham acesso?

curl -X PUT \
  'https://api.agendor.com.br/v3/deals/1012' \
  -H 'authorization: Token xxxxx-xxxxx-xxxxx-xxxx-xxxxx' \
  -H 'content-type: application/json' \
  -d '{
	"allowToAllUsers": true
}'

Esse mesmo parâmetro pode ser usado para as rotas /people e /deals .

Dúvidas com relação a esse conteúdo? Procure nossa equipe de Suporte nos canais disponíveis!